From 502e171974fb5c6cd056c083a7fc1f00533d4556 Mon Sep 17 00:00:00 2001 From: Joel Speed Date: Mon, 2 Dec 2024 15:31:36 +0000 Subject: [PATCH] Auto-fix fixable linter issues --- apiserver/v1/types_apirequestcount.go | 3 +- .../kube-apiserver_apirequestcounts.crd.yaml | 4 +- .../AAA_ungated.yaml | 4 +- .../v1/zz_generated.swagger_doc_generated.go | 2 +- apps/v1/generated.proto | 160 +- apps/v1/types.go | 160 +- apps/v1/zz_generated.swagger_doc_generated.go | 160 +- authorization/v1/generated.proto | 134 +- authorization/v1/types.go | 134 +- ...erator_01_rolebindingrestrictions.crd.yaml | 22 +- .../AAA_ungated.yaml | 22 +- .../v1/zz_generated.swagger_doc_generated.go | 134 +- build/v1/generated.proto | 42 +- build/v1/types.go | 42 +- .../v1/zz_generated.swagger_doc_generated.go | 42 +- cloudnetwork/v1/generated.proto | 5 - cloudnetwork/v1/types.go | 5 - config/v1/types.go | 47 +- config/v1/types_apiserver.go | 3 - config/v1/types_authentication.go | 74 +- config/v1/types_build.go | 27 +- config/v1/types_cluster_operator.go | 9 - config/v1/types_cluster_version.go | 34 +- config/v1/types_console.go | 1 - config/v1/types_dns.go | 3 +- config/v1/types_feature.go | 4 +- config/v1/types_image.go | 1 - config/v1/types_image_content_policy.go | 2 - config/v1/types_image_digest_mirror_set.go | 2 - config/v1/types_image_tag_mirror_set.go | 2 - config/v1/types_infrastructure.go | 144 +- config/v1/types_ingress.go | 10 +- config/v1/types_network.go | 17 +- config/v1/types_node.go | 5 +- config/v1/types_oauth.go | 1 - config/v1/types_project.go | 1 - config/v1/types_proxy.go | 3 +- config/v1/types_scheduling.go | 3 +- config/v1/types_testreporting.go | 9 +- ...1_clusterversions-CustomNoUpgrade.crd.yaml | 10 +- ...erator_01_clusterversions-Default.crd.yaml | 10 +- ...usterversions-DevPreviewNoUpgrade.crd.yaml | 10 +- ...sterversions-TechPreviewNoUpgrade.crd.yaml | 10 +- ...000_03_config-operator_01_proxies.crd.yaml | 2 +- ...tor_01_authentications-Hypershift.crd.yaml | 58 +- ...ons-SelfManagedHA-CustomNoUpgrade.crd.yaml | 58 +- ...SelfManagedHA-DevPreviewNoUpgrade.crd.yaml | 58 +- ...elfManagedHA-TechPreviewNoUpgrade.crd.yaml | 58 +- ...1_infrastructures-CustomNoUpgrade.crd.yaml | 76 +- ...erator_01_infrastructures-Default.crd.yaml | 76 +- ...frastructures-DevPreviewNoUpgrade.crd.yaml | 76 +- ...rastructures-TechPreviewNoUpgrade.crd.yaml | 76 +- ...00_10_config-operator_01_networks.crd.yaml | 16 +- ...operator_01_nodes-CustomNoUpgrade.crd.yaml | 4 +- ..._config-operator_01_nodes-Default.crd.yaml | 4 +- ...ator_01_nodes-DevPreviewNoUpgrade.crd.yaml | 4 +- ...tor_01_nodes-TechPreviewNoUpgrade.crd.yaml | 4 +- ...tor_01_schedulers-CustomNoUpgrade.crd.yaml | 2 +- ...ig-operator_01_schedulers-Default.crd.yaml | 2 +- ...01_schedulers-DevPreviewNoUpgrade.crd.yaml | 2 +- ...1_schedulers-TechPreviewNoUpgrade.crd.yaml | 2 +- ...hift-controller-manager_01_builds.crd.yaml | 30 +- .../ExternalOIDC.yaml | 58 +- .../AAA_ungated.yaml | 30 +- .../AAA_ungated.yaml | 10 +- .../SignatureStores.yaml | 10 +- .../AAA_ungated.yaml | 76 +- .../AWSClusterHostedDNS.yaml | 76 +- .../BareMetalLoadBalancer.yaml | 76 +- .../GCPClusterHostedDNS.yaml | 76 +- .../GCPLabelsTags.yaml | 76 +- .../VSphereControlPlaneMachineSet.yaml | 76 +- .../VSphereMultiNetworks.yaml | 76 +- .../VSphereMultiVCenters.yaml | 76 +- .../AAA_ungated.yaml | 16 +- .../NetworkDiagnosticsConfig.yaml | 16 +- .../AAA_ungated.yaml | 4 +- .../MinimumKubeletVersion.yaml | 4 +- .../AAA_ungated.yaml | 2 +- .../AAA_ungated.yaml | 2 +- .../DynamicResourceAllocation.yaml | 2 +- .../v1/zz_generated.swagger_doc_generated.go | 236 +- config/v1alpha1/types_backup.go | 29 +- config/v1alpha1/types_cluster_image_policy.go | 6 +- config/v1alpha1/types_image_policy.go | 30 +- config/v1alpha1/types_insights.go | 2 +- ...erator_01_backups-CustomNoUpgrade.crd.yaml | 16 +- ...or_01_backups-DevPreviewNoUpgrade.crd.yaml | 16 +- ...r_01_backups-TechPreviewNoUpgrade.crd.yaml | 16 +- .../AutomatedEtcdBackup.yaml | 16 +- .../zz_generated.swagger_doc_generated.go | 16 +- console/v1/types_console_link.go | 2 +- console/v1/types_console_plugin.go | 32 +- console/v1/types_console_quick_start.go | 12 - console/v1/types_console_sample.go | 18 +- .../00_consolelinks.crd.yaml | 2 +- .../AAA_ungated.yaml | 2 +- .../v1/zz_generated.swagger_doc_generated.go | 2 +- example/v1/types_stable.go | 7 +- example/v1alpha1/types_notstable.go | 2 +- helm/v1beta1/types_helm_chart_repository.go | 1 - .../types_project_helm_chart_repository.go | 1 - image/v1/generated.proto | 164 +- image/v1/types.go | 164 +- .../v1/zz_generated.swagger_doc_generated.go | 164 +- imageregistry/v1/types.go | 18 +- .../00_configs.crd.yaml | 32 +- .../AAA_ungated.yaml | 32 +- .../ChunkSizeMiB.yaml | 32 +- .../v1/zz_generated.swagger_doc_generated.go | 16 +- insights/v1alpha1/types_insights.go | 27 +- kubecontrolplane/v1/types.go | 6 +- .../v1/zz_generated.swagger_doc_generated.go | 6 +- legacyconfig/v1/types.go | 524 ++-- .../v1/zz_generated.swagger_doc_generated.go | 524 ++-- machine/v1/types_alibabaprovider.go | 42 +- machine/v1/types_aws.go | 14 +- machine/v1/types_controlplanemachineset.go | 77 +- machine/v1/types_nutanixprovider.go | 36 +- machine/v1/types_powervsprovider.go | 14 +- ...lplanemachinesets-CustomNoUpgrade.crd.yaml | 86 +- ...1_controlplanemachinesets-Default.crd.yaml | 86 +- ...nemachinesets-DevPreviewNoUpgrade.crd.yaml | 86 +- ...emachinesets-TechPreviewNoUpgrade.crd.yaml | 86 +- .../AAA_ungated.yaml | 86 +- .../MachineAPIMigration.yaml | 86 +- .../v1/zz_generated.swagger_doc_generated.go | 112 +- machine/v1alpha1/types_openstack.go | 18 +- .../zz_generated.swagger_doc_generated.go | 10 +- machine/v1beta1/types_awsprovider.go | 64 +- machine/v1beta1/types_azureprovider.go | 110 +- machine/v1beta1/types_gcpprovider.go | 94 +- machine/v1beta1/types_machine.go | 40 +- machine/v1beta1/types_machinehealthcheck.go | 8 +- machine/v1beta1/types_machineset.go | 16 +- machine/v1beta1/types_provider.go | 17 +- machine/v1beta1/types_vsphereprovider.go | 40 +- ...achine-api_01_machinehealthchecks.crd.yaml | 14 +- ...e-api_01_machines-CustomNoUpgrade.crd.yaml | 56 +- ...0_machine-api_01_machines-Default.crd.yaml | 56 +- ...i_01_machines-DevPreviewNoUpgrade.crd.yaml | 56 +- ..._01_machines-TechPreviewNoUpgrade.crd.yaml | 56 +- ...pi_01_machinesets-CustomNoUpgrade.crd.yaml | 58 +- ...achine-api_01_machinesets-Default.crd.yaml | 58 +- ...1_machinesets-DevPreviewNoUpgrade.crd.yaml | 58 +- ..._machinesets-TechPreviewNoUpgrade.crd.yaml | 58 +- .../AAA_ungated.yaml | 14 +- .../AAA_ungated.yaml | 56 +- .../MachineAPIMigration.yaml | 56 +- .../AAA_ungated.yaml | 58 +- .../MachineAPIMigration.yaml | 58 +- .../zz_generated.swagger_doc_generated.go | 354 +-- machineconfiguration/v1/types.go | 94 +- ...config_01_containerruntimeconfigs.crd.yaml | 2 +- ...controllerconfigs-CustomNoUpgrade.crd.yaml | 90 +- ...nfig_01_controllerconfigs-Default.crd.yaml | 90 +- ...rollerconfigs-DevPreviewNoUpgrade.crd.yaml | 90 +- ...ollerconfigs-TechPreviewNoUpgrade.crd.yaml | 90 +- ..._machine-config_01_kubeletconfigs.crd.yaml | 2 +- ..._machine-config_01_machineconfigs.crd.yaml | 6 +- .../AAA_ungated.yaml | 2 +- .../AAA_ungated.yaml | 90 +- .../AWSClusterHostedDNS.yaml | 90 +- .../BareMetalLoadBalancer.yaml | 90 +- .../GCPClusterHostedDNS.yaml | 90 +- .../GCPLabelsTags.yaml | 90 +- .../VSphereControlPlaneMachineSet.yaml | 90 +- .../VSphereMultiNetworks.yaml | 90 +- .../VSphereMultiVCenters.yaml | 90 +- .../AAA_ungated.yaml | 2 +- .../AAA_ungated.yaml | 6 +- .../v1/zz_generated.swagger_doc_generated.go | 20 +- .../v1alpha1/types_machineconfignode.go | 22 +- .../v1alpha1/types_machineosbuild.go | 26 +- .../v1alpha1/types_machineosconfig.go | 22 +- .../v1alpha1/types_pinnedimageset.go | 6 +- ...1_machineosbuilds-CustomNoUpgrade.crd.yaml | 2 +- ...chineosbuilds-DevPreviewNoUpgrade.crd.yaml | 2 +- ...hineosbuilds-TechPreviewNoUpgrade.crd.yaml | 2 +- .../OnClusterBuild.yaml | 2 +- .../zz_generated.swagger_doc_generated.go | 2 +- monitoring/v1/types.go | 22 +- network/v1/generated.proto | 44 +- network/v1/types.go | 44 +- .../001_clusternetworks.crd.yaml | 16 +- .../002_hostsubnets.crd.yaml | 10 +- .../003_netnamespaces.crd.yaml | 6 +- .../AAA_ungated.yaml | 16 +- .../AAA_ungated.yaml | 10 +- .../AAA_ungated.yaml | 6 +- .../v1/zz_generated.swagger_doc_generated.go | 42 +- network/v1alpha1/types_dnsnameresolver.go | 14 +- networkoperator/v1/generated.proto | 49 +- networkoperator/v1/types_egressrouter.go | 49 +- .../001_egressrouters.crd.yaml | 26 +- .../AAA_ungated.yaml | 26 +- .../v1/zz_generated.swagger_doc_generated.go | 26 +- oauth/v1/generated.proto | 94 +- oauth/v1/types.go | 76 +- .../v1/zz_generated.swagger_doc_generated.go | 76 +- .../generated_openapi/zz_generated.openapi.go | 2453 ++++++++-------- openapi/openapi.json | 2482 +++++++++-------- openshiftcontrolplane/v1/types.go | 38 +- .../v1/zz_generated.swagger_doc_generated.go | 20 +- operator/v1/types.go | 14 +- operator/v1/types_authentication.go | 5 +- operator/v1/types_cloudcredential.go | 3 +- operator/v1/types_config.go | 3 +- operator/v1/types_console.go | 35 +- operator/v1/types_csi_cluster_driver.go | 23 +- operator/v1/types_csi_snapshot.go | 1 - operator/v1/types_dns.go | 17 +- operator/v1/types_etcd.go | 4 +- operator/v1/types_ingress.go | 47 +- operator/v1/types_insights.go | 16 +- operator/v1/types_kubeapiserver.go | 3 +- operator/v1/types_kubecontrollermanager.go | 3 +- .../v1/types_kubestorageversionmigrator.go | 3 +- operator/v1/types_machineconfiguration.go | 42 +- operator/v1/types_network.go | 42 +- operator/v1/types_olm.go | 2 +- operator/v1/types_openshiftapiserver.go | 3 +- .../v1/types_openshiftcontrollermanager.go | 3 +- operator/v1/types_scheduler.go | 3 +- operator/v1/types_serviceca.go | 3 +- operator/v1/types_servicecatalogapiserver.go | 3 +- .../types_servicecatalogcontrollermanager.go | 3 +- operator/v1/types_storage.go | 3 +- ...ud-credential_00_cloudcredentials.crd.yaml | 2 +- ...authentication_01_authentications.crd.yaml | 4 +- .../0000_50_console_01_consoles.crd.yaml | 6 +- ...0_csi-driver_01_clustercsidrivers.crd.yaml | 4 +- ..._50_ingress_00_ingresscontrollers.crd.yaml | 2 +- .../0000_50_storage_01_storages.crd.yaml | 2 +- .../0000_70_dns_00_dnses.crd.yaml | 10 +- ...twork_01_networks-CustomNoUpgrade.crd.yaml | 38 +- ...00_70_network_01_networks-Default.crd.yaml | 38 +- ...k_01_networks-DevPreviewNoUpgrade.crd.yaml | 38 +- ..._01_networks-TechPreviewNoUpgrade.crd.yaml | 38 +- .../AAA_ungated.yaml | 4 +- .../AAA_ungated.yaml | 2 +- .../AAA_ungated.yaml | 4 +- .../AWSEFSDriverVolumeMetrics.yaml | 4 +- .../VSphereDriverConfiguration.yaml | 4 +- .../AAA_ungated.yaml | 6 +- .../AAA_ungated.yaml | 10 +- .../AAA_ungated.yaml | 2 +- .../IngressControllerLBSubnetsAWS.yaml | 2 +- .../SetEIPForNLBIngressController.yaml | 2 +- .../AAA_ungated.yaml | 38 +- .../AdditionalRoutingCapabilities.yaml | 38 +- .../NetworkLiveMigration.yaml | 38 +- .../RouteAdvertisements.yaml | 38 +- .../AAA_ungated.yaml | 2 +- .../v1/zz_generated.swagger_doc_generated.go | 90 +- operator/v1alpha1/types.go | 2 +- operator/v1alpha1/types_etcdbackup.go | 11 +- .../types_image_content_source_policy.go | 1 - operator/v1alpha1/types_olm.go | 4 +- ...cd_01_etcdbackups-CustomNoUpgrade.crd.yaml | 2 +- ...1_etcdbackups-DevPreviewNoUpgrade.crd.yaml | 2 +- ..._etcdbackups-TechPreviewNoUpgrade.crd.yaml | 2 +- .../AutomatedEtcdBackup.yaml | 2 +- .../zz_generated.swagger_doc_generated.go | 6 +- .../v1alpha1/types_conditioncheck.go | 39 +- ...k_01_podnetworkconnectivitychecks.crd.yaml | 54 +- .../AAA_ungated.yaml | 54 +- .../zz_generated.swagger_doc_generated.go | 30 +- operatoringress/v1/types.go | 8 +- osin/v1/types.go | 6 +- osin/v1/zz_generated.swagger_doc_generated.go | 6 +- ...operator_01_clusterresourcequotas.crd.yaml | 16 +- ...000_03_config-operator_01_proxies.crd.yaml | 2 +- ...erator_01_rolebindingrestrictions.crd.yaml | 22 +- ...ontextconstraints-CustomNoUpgrade.crd.yaml | 72 +- ...ecuritycontextconstraints-Default.crd.yaml | 72 +- ...xtconstraints-DevPreviewNoUpgrade.crd.yaml | 72 +- ...tconstraints-TechPreviewNoUpgrade.crd.yaml | 72 +- ...tor_01_authentications-Hypershift.crd.yaml | 58 +- ...ons-SelfManagedHA-CustomNoUpgrade.crd.yaml | 58 +- ...SelfManagedHA-DevPreviewNoUpgrade.crd.yaml | 58 +- ...elfManagedHA-TechPreviewNoUpgrade.crd.yaml | 58 +- ...erator_01_backups-CustomNoUpgrade.crd.yaml | 16 +- ...or_01_backups-DevPreviewNoUpgrade.crd.yaml | 16 +- ...r_01_backups-TechPreviewNoUpgrade.crd.yaml | 16 +- ...1_infrastructures-CustomNoUpgrade.crd.yaml | 76 +- ...erator_01_infrastructures-Default.crd.yaml | 76 +- ...frastructures-DevPreviewNoUpgrade.crd.yaml | 76 +- ...rastructures-TechPreviewNoUpgrade.crd.yaml | 76 +- ...00_10_config-operator_01_networks.crd.yaml | 16 +- ...operator_01_nodes-CustomNoUpgrade.crd.yaml | 4 +- ..._config-operator_01_nodes-Default.crd.yaml | 4 +- ...ator_01_nodes-DevPreviewNoUpgrade.crd.yaml | 4 +- ...tor_01_nodes-TechPreviewNoUpgrade.crd.yaml | 4 +- ...tor_01_schedulers-CustomNoUpgrade.crd.yaml | 2 +- ...ig-operator_01_schedulers-Default.crd.yaml | 2 +- ...01_schedulers-DevPreviewNoUpgrade.crd.yaml | 2 +- ...1_schedulers-TechPreviewNoUpgrade.crd.yaml | 2 +- ...lplanemachinesets-CustomNoUpgrade.crd.yaml | 86 +- ...1_controlplanemachinesets-Default.crd.yaml | 86 +- ...nemachinesets-DevPreviewNoUpgrade.crd.yaml | 86 +- ...emachinesets-TechPreviewNoUpgrade.crd.yaml | 86 +- ...cd_01_etcdbackups-CustomNoUpgrade.crd.yaml | 2 +- ...1_etcdbackups-DevPreviewNoUpgrade.crd.yaml | 2 +- ..._etcdbackups-TechPreviewNoUpgrade.crd.yaml | 2 +- ...hift-controller-manager_01_builds.crd.yaml | 30 +- ...authentication_01_authentications.crd.yaml | 4 +- ...0_csi-driver_01_clustercsidrivers.crd.yaml | 4 +- .../crds/0000_50_storage_01_storages.crd.yaml | 2 +- ...config_01_containerruntimeconfigs.crd.yaml | 2 +- ...controllerconfigs-CustomNoUpgrade.crd.yaml | 90 +- ...nfig_01_controllerconfigs-Default.crd.yaml | 90 +- ...rollerconfigs-DevPreviewNoUpgrade.crd.yaml | 90 +- ...ollerconfigs-TechPreviewNoUpgrade.crd.yaml | 90 +- ..._machine-config_01_kubeletconfigs.crd.yaml | 2 +- ..._machine-config_01_machineconfigs.crd.yaml | 6 +- ...1_machineosbuilds-CustomNoUpgrade.crd.yaml | 2 +- ...chineosbuilds-DevPreviewNoUpgrade.crd.yaml | 2 +- ...hineosbuilds-TechPreviewNoUpgrade.crd.yaml | 2 +- platform/v1alpha1/types.go | 6 +- project/v1/generated.proto | 14 +- project/v1/types.go | 14 +- .../v1/zz_generated.swagger_doc_generated.go | 14 +- quota/v1/generated.proto | 24 +- quota/v1/types.go | 24 +- ...operator_01_clusterresourcequotas.crd.yaml | 16 +- .../AAA_ungated.yaml | 16 +- .../v1/zz_generated.swagger_doc_generated.go | 24 +- route/v1/generated.proto | 16 +- route/v1/types.go | 16 +- .../routes-CustomNoUpgrade.crd.yaml | 8 +- .../routes-Default.crd.yaml | 8 +- .../routes-DevPreviewNoUpgrade.crd.yaml | 8 +- .../routes-TechPreviewNoUpgrade.crd.yaml | 8 +- .../AAA_ungated.yaml | 8 +- .../RouteExternalCertificate.yaml | 8 +- .../v1/zz_generated.swagger_doc_generated.go | 8 +- samples/v1/generated.proto | 1 - samples/v1/types_config.go | 1 - security/v1/generated.proto | 68 +- security/v1/types.go | 68 +- ...ontextconstraints-CustomNoUpgrade.crd.yaml | 72 +- ...ecuritycontextconstraints-Default.crd.yaml | 72 +- ...xtconstraints-DevPreviewNoUpgrade.crd.yaml | 72 +- ...tconstraints-TechPreviewNoUpgrade.crd.yaml | 72 +- .../AAA_ungated.yaml | 72 +- .../UserNamespacesPodSecurityStandards.yaml | 72 +- .../v1/zz_generated.swagger_doc_generated.go | 68 +- servicecertsigner/v1alpha1/types.go | 2 +- .../zz_generated.swagger_doc_generated.go | 2 +- .../v1alpha1/types_shared_configmap.go | 25 +- .../v1alpha1/types_shared_secret.go | 25 +- .../sharedconfigmaps.crd.yaml | 42 +- .../sharedsecrets.crd.yaml | 42 +- .../AAA_ungated.yaml | 42 +- .../AAA_ungated.yaml | 42 +- .../zz_generated.swagger_doc_generated.go | 4 +- template/v1/generated.proto | 26 +- template/v1/types.go | 26 +- .../v1/zz_generated.swagger_doc_generated.go | 26 +- unidling/v1alpha1/types.go | 6 +- .../zz_generated.swagger_doc_generated.go | 6 +- user/v1/generated.proto | 26 +- user/v1/types.go | 26 +- user/v1/zz_generated.swagger_doc_generated.go | 26 +- 365 files changed, 9031 insertions(+), 9237 deletions(-) diff --git a/apiserver/v1/types_apirequestcount.go b/apiserver/v1/types_apirequestcount.go index eb4918a6613..645d796f775 100644 --- a/apiserver/v1/types_apirequestcount.go +++ b/apiserver/v1/types_apirequestcount.go @@ -35,7 +35,6 @@ type APIRequestCount struct { metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` // spec defines the characteristics of the resource. - // +kubebuilder:validation:Required // +required Spec APIRequestCountSpec `json:"spec"` @@ -126,7 +125,7 @@ type PerNodeAPIRequestLog struct { // PerUserAPIRequestCount contains logs of a user's requests. type PerUserAPIRequestCount struct { - // userName that made the request. + // username that made the request. // +kubebuilder:validation:MaxLength=512 UserName string `json:"username"` diff --git a/apiserver/v1/zz_generated.crd-manifests/kube-apiserver_apirequestcounts.crd.yaml b/apiserver/v1/zz_generated.crd-manifests/kube-apiserver_apirequestcounts.crd.yaml index d20ad2b0581..5754d812f30 100644 --- a/apiserver/v1/zz_generated.crd-manifests/kube-apiserver_apirequestcounts.crd.yaml +++ b/apiserver/v1/zz_generated.crd-manifests/kube-apiserver_apirequestcounts.crd.yaml @@ -186,7 +186,7 @@ spec: maxLength: 1024 type: string username: - description: userName that made the request. + description: username that made the request. maxLength: 512 type: string required: @@ -282,7 +282,7 @@ spec: maxLength: 1024 type: string username: - description: userName that made the request. + description: username that made the request. maxLength: 512 type: string required: diff --git a/apiserver/v1/zz_generated.featuregated-crd-manifests/apirequestcounts.apiserver.openshift.io/AAA_ungated.yaml b/apiserver/v1/zz_generated.featuregated-crd-manifests/apirequestcounts.apiserver.openshift.io/AAA_ungated.yaml index a30b5ac9d0d..234f596c1d3 100644 --- a/apiserver/v1/zz_generated.featuregated-crd-manifests/apirequestcounts.apiserver.openshift.io/AAA_ungated.yaml +++ b/apiserver/v1/zz_generated.featuregated-crd-manifests/apirequestcounts.apiserver.openshift.io/AAA_ungated.yaml @@ -187,7 +187,7 @@ spec: maxLength: 1024 type: string username: - description: userName that made the request. + description: username that made the request. maxLength: 512 type: string required: @@ -283,7 +283,7 @@ spec: maxLength: 1024 type: string username: - description: userName that made the request. + description: username that made the request. maxLength: 512 type: string required: diff --git a/apiserver/v1/zz_generated.swagger_doc_generated.go b/apiserver/v1/zz_generated.swagger_doc_generated.go index 27d74b6c191..b3d6b615fc6 100644 --- a/apiserver/v1/zz_generated.swagger_doc_generated.go +++ b/apiserver/v1/zz_generated.swagger_doc_generated.go @@ -74,7 +74,7 @@ func (PerResourceAPIRequestLog) SwaggerDoc() map[string]string { var map_PerUserAPIRequestCount = map[string]string{ "": "PerUserAPIRequestCount contains logs of a user's requests.", - "username": "userName that made the request.", + "username": "username that made the request.", "userAgent": "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.", "requestCount": "requestCount of requests by the user across all verbs.", "byVerb": "byVerb details by verb.", diff --git a/apps/v1/generated.proto b/apps/v1/generated.proto index 010f36b9558..6f50fcaf959 100644 --- a/apps/v1/generated.proto +++ b/apps/v1/generated.proto @@ -15,39 +15,39 @@ option go_package = "github.com/openshift/api/apps/v1"; // CustomDeploymentStrategyParams are the input to the Custom deployment strategy. message CustomDeploymentStrategyParams { - // Image specifies a container image which can carry out a deployment. + // image specifies a container image which can carry out a deployment. optional string image = 1; - // Environment holds the environment which will be given to the container for Image. + // environment holds the environment which will be given to the container for Image. repeated .k8s.io.api.core.v1.EnvVar environment = 2; - // Command is optional and overrides CMD in the container Image. + // command is optional and overrides CMD in the container Image. repeated string command = 3; } // DeploymentCause captures information about a particular cause of a deployment. message DeploymentCause { - // Type of the trigger that resulted in the creation of a new deployment + // type of the trigger that resulted in the creation of a new deployment optional string type = 1; - // ImageTrigger contains the image trigger details, if this trigger was fired based on an image change + // imageTrigger contains the image trigger details, if this trigger was fired based on an image change optional DeploymentCauseImageTrigger imageTrigger = 2; } // DeploymentCauseImageTrigger represents details about the cause of a deployment originating // from an image change trigger message DeploymentCauseImageTrigger { - // From is a reference to the changed object which triggered a deployment. The field may have + // from is a reference to the changed object which triggered a deployment. The field may have // the kinds DockerImage, ImageStreamTag, or ImageStreamImage. optional .k8s.io.api.core.v1.ObjectReference from = 1; } // DeploymentCondition describes the state of a deployment config at a certain point. message DeploymentCondition { - // Type of deployment condition. + // type of deployment condition. optional string type = 1; - // Status of the condition, one of True, False, Unknown. + // status of the condition, one of True, False, Unknown. optional string status = 2; // The last time this condition was updated. @@ -81,10 +81,10 @@ message DeploymentConfig { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata optional .k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1; - // Spec represents a desired deployment state and how to deploy to it. + // spec represents a desired deployment state and how to deploy to it. optional DeploymentConfigSpec spec = 2; - // Status represents the current deployment state. + // status represents the current deployment state. // +optional optional DeploymentConfigStatus status = 3; } @@ -98,7 +98,7 @@ message DeploymentConfigList { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata optional .k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1; - // Items is a list of deployment configs + // items is a list of deployment configs repeated DeploymentConfig items = 2; } @@ -107,108 +107,108 @@ message DeploymentConfigList { // Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). // +openshift:compatibility-gen:level=1 message DeploymentConfigRollback { - // Name of the deployment config that will be rolled back. + // name of the deployment config that will be rolled back. optional string name = 1; - // UpdatedAnnotations is a set of new annotations that will be added in the deployment config. + // updatedAnnotations is a set of new annotations that will be added in the deployment config. map updatedAnnotations = 2; - // Spec defines the options to rollback generation. + // spec defines the options to rollback generation. optional DeploymentConfigRollbackSpec spec = 3; } // DeploymentConfigRollbackSpec represents the options for rollback generation. message DeploymentConfigRollbackSpec { - // From points to a ReplicationController which is a deployment. + // from points to a ReplicationController which is a deployment. optional .k8s.io.api.core.v1.ObjectReference from = 1; - // Revision to rollback to. If set to 0, rollback to the last revision. + // revision to rollback to. If set to 0, rollback to the last revision. optional int64 revision = 2; - // IncludeTriggers specifies whether to include config Triggers. + // includeTriggers specifies whether to include config Triggers. optional bool includeTriggers = 3; - // IncludeTemplate specifies whether to include the PodTemplateSpec. + // includeTemplate specifies whether to include the PodTemplateSpec. optional bool includeTemplate = 4; - // IncludeReplicationMeta specifies whether to include the replica count and selector. + // includeReplicationMeta specifies whether to include the replica count and selector. optional bool includeReplicationMeta = 5; - // IncludeStrategy specifies whether to include the deployment Strategy. + // includeStrategy specifies whether to include the deployment Strategy. optional bool includeStrategy = 6; } // DeploymentConfigSpec represents the desired state of the deployment. message DeploymentConfigSpec { - // Strategy describes how a deployment is executed. + // strategy describes how a deployment is executed. // +optional optional DeploymentStrategy strategy = 1; - // MinReadySeconds is the minimum number of seconds for which a newly created pod should + // 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) optional int32 minReadySeconds = 9; - // Triggers determine how updates to a DeploymentConfig result in new deployments. If no triggers + // 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. // +optional optional DeploymentTriggerPolicies triggers = 2; - // Replicas is the number of desired replicas. + // replicas is the number of desired replicas. // +optional optional int32 replicas = 3; - // RevisionHistoryLimit is the number of old ReplicationControllers to retain to allow for rollbacks. + // 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.) optional int32 revisionHistoryLimit = 4; - // Test ensures that this deployment config will have zero replicas except while a deployment is running. This allows the + // 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. // +optional optional bool test = 5; - // Paused indicates that the deployment config is paused resulting in no new deployments on template + // 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. optional bool paused = 6; - // Selector is a label query over pods that should match the Replicas count. + // selector is a label query over pods that should match the Replicas count. map selector = 7; - // Template is the object that describes the pod that will be created if + // template is the object that describes the pod that will be created if // insufficient replicas are detected. optional .k8s.io.api.core.v1.PodTemplateSpec template = 8; } // DeploymentConfigStatus represents the current deployment state. message DeploymentConfigStatus { - // LatestVersion is used to determine whether the current deployment associated with a deployment + // latestVersion is used to determine whether the current deployment associated with a deployment // config is out of sync. optional int64 latestVersion = 1; - // ObservedGeneration is the most recent generation observed by the deployment config controller. + // observedGeneration is the most recent generation observed by the deployment config controller. optional int64 observedGeneration = 2; - // Replicas is the total number of pods targeted by this deployment config. + // replicas is the total number of pods targeted by this deployment config. optional int32 replicas = 3; - // UpdatedReplicas is the total number of non-terminated pods targeted by this deployment config + // updatedReplicas is the total number of non-terminated pods targeted by this deployment config // that have the desired template spec. optional int32 updatedReplicas = 4; - // AvailableReplicas is the total number of available pods targeted by this deployment config. + // availableReplicas is the total number of available pods targeted by this deployment config. optional int32 availableReplicas = 5; - // UnavailableReplicas is the total number of unavailable pods targeted by this deployment config. + // unavailableReplicas is the total number of unavailable pods targeted by this deployment config. optional int32 unavailableReplicas = 6; - // Details are the reasons for the update to this deployment config. + // 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 optional DeploymentDetails details = 7; - // Conditions represents the latest available observations of a deployment config's current state. + // conditions represents the latest available observations of a deployment config's current state. // +patchMergeKey=type // +patchStrategy=merge repeated DeploymentCondition conditions = 8; @@ -219,10 +219,10 @@ message DeploymentConfigStatus { // DeploymentDetails captures information about the causes of a deployment. message DeploymentDetails { - // Message is the user specified change message, if this deployment was triggered manually by the user + // message is the user specified change message, if this deployment was triggered manually by the user optional string message = 1; - // Causes are extended data associated with all the causes for creating a new deployment + // causes are extended data associated with all the causes for creating a new deployment repeated DeploymentCause causes = 2; } @@ -241,7 +241,7 @@ message DeploymentLogOptions { // The container for which to stream logs. Defaults to only container if there is one container in the pod. optional string container = 1; - // Follow if true indicates that the build log should be streamed until + // follow if true indicates that the build log should be streamed until // the build terminates. optional bool follow = 2; @@ -273,12 +273,12 @@ message DeploymentLogOptions { // slightly more or slightly less than the specified limit. optional int64 limitBytes = 8; - // NoWait if true causes the call to return immediately even if the deployment + // 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. // TODO: Fix the tag to 'noWait' in v2 optional bool nowait = 9; - // Version of the deployment for which to view logs. + // version of the deployment for which to view logs. optional int64 version = 10; } @@ -287,17 +287,17 @@ message DeploymentLogOptions { // Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). // +openshift:compatibility-gen:level=1 message DeploymentRequest { - // Name of the deployment config for requesting a new deployment. + // name of the deployment config for requesting a new deployment. optional string name = 1; - // Latest will update the deployment config with the latest state from all triggers. + // latest will update the deployment config with the latest state from all triggers. optional bool latest = 2; - // Force will try to force a new deployment to run. If the deployment config is paused, + // 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. optional bool force = 3; - // ExcludeTriggers instructs the instantiator to avoid processing the specified triggers. + // 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. repeated string excludeTriggers = 4; @@ -305,53 +305,53 @@ message DeploymentRequest { // DeploymentStrategy describes how to perform a deployment. message DeploymentStrategy { - // Type is the name of a deployment strategy. + // type is the name of a deployment strategy. // +optional optional string type = 1; - // CustomParams are the input to the Custom deployment strategy, and may also + // 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. optional CustomDeploymentStrategyParams customParams = 2; - // RecreateParams are the input to the Recreate deployment strategy. + // recreateParams are the input to the Recreate deployment strategy. optional RecreateDeploymentStrategyParams recreateParams = 3; - // RollingParams are the input to the Rolling deployment strategy. + // rollingParams are the input to the Rolling deployment strategy. optional RollingDeploymentStrategyParams rollingParams = 4; - // Resources contains resource requirements to execute the deployment and any hooks. + // resources contains resource requirements to execute the deployment and any hooks. optional .k8s.io.api.core.v1.ResourceRequirements resources = 5; - // Labels is a set of key, value pairs added to custom deployer and lifecycle pre/post hook pods. + // labels is a set of key, value pairs added to custom deployer and lifecycle pre/post hook pods. map labels = 6; - // Annotations is a set of key, value pairs added to custom deployer and lifecycle pre/post hook pods. + // annotations is a set of key, value pairs added to custom deployer and lifecycle pre/post hook pods. map annotations = 7; - // ActiveDeadlineSeconds is the duration in seconds that the deployer pods for this deployment + // 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. optional int64 activeDeadlineSeconds = 8; } // DeploymentTriggerImageChangeParams represents the parameters to the ImageChange trigger. message DeploymentTriggerImageChangeParams { - // Automatic means that the detection of a new tag value should result in an image update + // automatic means that the detection of a new tag value should result in an image update // inside the pod template. optional bool automatic = 1; - // ContainerNames is used to restrict tag updates to the specified set of container names in a pod. + // 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. repeated string containerNames = 2; - // From is a reference to an image stream tag to watch for changes. From.Name is the only + // 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. optional .k8s.io.api.core.v1.ObjectReference from = 3; - // LastTriggeredImage is the last image to be triggered. + // lastTriggeredImage is the last image to be triggered. optional string lastTriggeredImage = 4; } @@ -366,10 +366,10 @@ message DeploymentTriggerPolicies { // DeploymentTriggerPolicy describes a policy for a single trigger that results in a new deployment. message DeploymentTriggerPolicy { - // Type of the trigger + // type of the trigger optional string type = 1; - // ImageChangeParams represents the parameters for the ImageChange trigger. + // imageChangeParams represents the parameters for the ImageChange trigger. optional DeploymentTriggerImageChangeParams imageChangeParams = 2; } @@ -377,17 +377,17 @@ message DeploymentTriggerPolicy { // based on the specified container which is assumed to be part of the // deployment template. message ExecNewPodHook { - // Command is the action command and its arguments. + // command is the action command and its arguments. repeated string command = 1; - // Env is a set of environment variables to supply to the hook pod's container. + // env is a set of environment variables to supply to the hook pod's container. repeated .k8s.io.api.core.v1.EnvVar env = 2; - // ContainerName is the name of a container in the deployment pod template + // containerName is the name of a container in the deployment pod template // whose container image will be used for the hook pod's container. optional string containerName = 3; - // Volumes is a list of named volumes from the pod template which should be + // 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. repeated string volumes = 4; @@ -395,32 +395,32 @@ message ExecNewPodHook { // LifecycleHook defines a specific deployment lifecycle action. Only one type of action may be specified at any time. message LifecycleHook { - // FailurePolicy specifies what action to take if the hook fails. + // failurePolicy specifies what action to take if the hook fails. optional string failurePolicy = 1; - // ExecNewPod specifies the options for a lifecycle hook backed by a pod. + // execNewPod specifies the options for a lifecycle hook backed by a pod. optional ExecNewPodHook execNewPod = 2; - // TagImages instructs the deployer to tag the current image referenced under a container onto an image stream tag. + // tagImages instructs the deployer to tag the current image referenced under a container onto an image stream tag. repeated TagImageHook tagImages = 3; } // RecreateDeploymentStrategyParams are the input to the Recreate deployment // strategy. message RecreateDeploymentStrategyParams { - // TimeoutSeconds is the time to wait for updates before giving up. If the + // timeoutSeconds is the time to wait for updates before giving up. If the // value is nil, a default will be used. optional int64 timeoutSeconds = 1; - // Pre is a lifecycle hook which is executed before the strategy manipulates + // pre is a lifecycle hook which is executed before the strategy manipulates // the deployment. All LifecycleHookFailurePolicy values are supported. optional LifecycleHook pre = 2; - // Mid is a lifecycle hook which is executed while the deployment is scaled down to zero before the first new + // 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. optional LifecycleHook mid = 3; - // Post is a lifecycle hook which is executed after the strategy has + // post is a lifecycle hook which is executed after the strategy has // finished all deployment logic. All LifecycleHookFailurePolicy values are supported. optional LifecycleHook post = 4; } @@ -428,19 +428,19 @@ message RecreateDeploymentStrategyParams { // RollingDeploymentStrategyParams are the input to the Rolling deployment // strategy. message RollingDeploymentStrategyParams { - // UpdatePeriodSeconds is the time to wait between individual pod updates. + // updatePeriodSeconds is the time to wait between individual pod updates. // If the value is nil, a default will be used. optional int64 updatePeriodSeconds = 1; - // IntervalSeconds is the time to wait between polling deployment status + // intervalSeconds is the time to wait between polling deployment status // after update. If the value is nil, a default will be used. optional int64 intervalSeconds = 2; - // TimeoutSeconds is the time to wait for updates before giving up. If the + // timeoutSeconds is the time to wait for updates before giving up. If the // value is nil, a default will be used. optional int64 timeoutSeconds = 3; - // MaxUnavailable is the maximum number of pods that can be unavailable + // 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. @@ -454,7 +454,7 @@ message RollingDeploymentStrategyParams { // all times during the update. optional .k8s.io.apimachinery.pkg.util.intstr.IntOrString maxUnavailable = 4; - // MaxSurge is the maximum number of pods that can be scheduled above the + // 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. @@ -468,11 +468,11 @@ message RollingDeploymentStrategyParams { // pods. optional .k8s.io.apimachinery.pkg.util.intstr.IntOrString maxSurge = 5; - // Pre is a lifecycle hook which is executed before the deployment process + // pre is a lifecycle hook which is executed before the deployment process // begins. All LifecycleHookFailurePolicy values are supported. optional LifecycleHook pre = 7; - // Post is a lifecycle hook which is executed after the strategy has + // post is a lifecycle hook which is executed after the strategy has // finished all deployment logic. All LifecycleHookFailurePolicy values // are supported. optional LifecycleHook post = 8; @@ -480,11 +480,11 @@ message RollingDeploymentStrategyParams { // TagImageHook is a request to tag the image in a particular container onto an ImageStreamTag. message TagImageHook { - // 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 + // 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. optional string containerName = 1; - // To is the target ImageStreamTag to set the container's image onto. + // to is the target ImageStreamTag to set the container's image onto. optional .k8s.io.api.core.v1.ObjectReference to = 2; } diff --git a/apps/v1/types.go b/apps/v1/types.go index 1465aea2783..619c30e828e 100644 --- a/apps/v1/types.go +++ b/apps/v1/types.go @@ -38,81 +38,81 @@ type DeploymentConfig struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` - // Spec represents a desired deployment state and how to deploy to it. + // spec represents a desired deployment state and how to deploy to it. Spec DeploymentConfigSpec `json:"spec" protobuf:"bytes,2,opt,name=spec"` - // Status represents the current deployment state. + // status represents the current deployment state. // +optional Status DeploymentConfigStatus `json:"status,omitempty" protobuf:"bytes,3,opt,name=status"` } // DeploymentConfigSpec represents the desired state of the deployment. type DeploymentConfigSpec struct { - // Strategy describes how a deployment is executed. + // strategy describes how a deployment is executed. // +optional Strategy DeploymentStrategy `json:"strategy" protobuf:"bytes,1,opt,name=strategy"` - // MinReadySeconds is the minimum number of seconds for which a newly created pod should + // 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) MinReadySeconds int32 `json:"minReadySeconds,omitempty" protobuf:"varint,9,opt,name=minReadySeconds"` - // Triggers determine how updates to a DeploymentConfig result in new deployments. If no triggers + // 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. // +optional Triggers DeploymentTriggerPolicies `json:"triggers" protobuf:"bytes,2,rep,name=triggers"` - // Replicas is the number of desired replicas. + // replicas is the number of desired replicas. // +optional Replicas int32 `json:"replicas" protobuf:"varint,3,opt,name=replicas"` - // RevisionHistoryLimit is the number of old ReplicationControllers to retain to allow for rollbacks. + // 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.) RevisionHistoryLimit *int32 `json:"revisionHistoryLimit,omitempty" protobuf:"varint,4,opt,name=revisionHistoryLimit"` - // Test ensures that this deployment config will have zero replicas except while a deployment is running. This allows the + // 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. // +optional Test bool `json:"test" protobuf:"varint,5,opt,name=test"` - // Paused indicates that the deployment config is paused resulting in no new deployments on template + // 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. Paused bool `json:"paused,omitempty" protobuf:"varint,6,opt,name=paused"` - // Selector is a label query over pods that should match the Replicas count. + // selector is a label query over pods that should match the Replicas count. Selector map[string]string `json:"selector,omitempty" protobuf:"bytes,7,rep,name=selector"` - // Template is the object that describes the pod that will be created if + // template is the object that describes the pod that will be created if // insufficient replicas are detected. Template *corev1.PodTemplateSpec `json:"template,omitempty" protobuf:"bytes,8,opt,name=template"` } // DeploymentStrategy describes how to perform a deployment. type DeploymentStrategy struct { - // Type is the name of a deployment strategy. + // type is the name of a deployment strategy. // +optional Type DeploymentStrategyType `json:"type,omitempty" protobuf:"bytes,1,opt,name=type,casttype=DeploymentStrategyType"` - // CustomParams are the input to the Custom deployment strategy, and may also + // 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. CustomParams *CustomDeploymentStrategyParams `json:"customParams,omitempty" protobuf:"bytes,2,opt,name=customParams"` - // RecreateParams are the input to the Recreate deployment strategy. + // recreateParams are the input to the Recreate deployment strategy. RecreateParams *RecreateDeploymentStrategyParams `json:"recreateParams,omitempty" protobuf:"bytes,3,opt,name=recreateParams"` - // RollingParams are the input to the Rolling deployment strategy. + // rollingParams are the input to the Rolling deployment strategy. RollingParams *RollingDeploymentStrategyParams `json:"rollingParams,omitempty" protobuf:"bytes,4,opt,name=rollingParams"` - // Resources contains resource requirements to execute the deployment and any hooks. + // resources contains resource requirements to execute the deployment and any hooks. Resources corev1.ResourceRequirements `json:"resources,omitempty" protobuf:"bytes,5,opt,name=resources"` - // Labels is a set of key, value pairs added to custom deployer and lifecycle pre/post hook pods. + // labels is a set of key, value pairs added to custom deployer and lifecycle pre/post hook pods. Labels map[string]string `json:"labels,omitempty" protobuf:"bytes,6,rep,name=labels"` - // Annotations is a set of key, value pairs added to custom deployer and lifecycle pre/post hook pods. + // annotations is a set of key, value pairs added to custom deployer and lifecycle pre/post hook pods. Annotations map[string]string `json:"annotations,omitempty" protobuf:"bytes,7,rep,name=annotations"` - // ActiveDeadlineSeconds is the duration in seconds that the deployer pods for this deployment + // 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. ActiveDeadlineSeconds *int64 `json:"activeDeadlineSeconds,omitempty" protobuf:"varint,8,opt,name=activeDeadlineSeconds"` } @@ -131,27 +131,27 @@ const ( // CustomDeploymentStrategyParams are the input to the Custom deployment strategy. type CustomDeploymentStrategyParams struct { - // Image specifies a container image which can carry out a deployment. + // image specifies a container image which can carry out a deployment. Image string `json:"image,omitempty" protobuf:"bytes,1,opt,name=image"` - // Environment holds the environment which will be given to the container for Image. + // environment holds the environment which will be given to the container for Image. Environment []corev1.EnvVar `json:"environment,omitempty" protobuf:"bytes,2,rep,name=environment"` - // Command is optional and overrides CMD in the container Image. + // command is optional and overrides CMD in the container Image. Command []string `json:"command,omitempty" protobuf:"bytes,3,rep,name=command"` } // RecreateDeploymentStrategyParams are the input to the Recreate deployment // strategy. type RecreateDeploymentStrategyParams struct { - // TimeoutSeconds is the time to wait for updates before giving up. If the + // timeoutSeconds is the time to wait for updates before giving up. If the // value is nil, a default will be used. TimeoutSeconds *int64 `json:"timeoutSeconds,omitempty" protobuf:"varint,1,opt,name=timeoutSeconds"` - // Pre is a lifecycle hook which is executed before the strategy manipulates + // pre is a lifecycle hook which is executed before the strategy manipulates // the deployment. All LifecycleHookFailurePolicy values are supported. Pre *LifecycleHook `json:"pre,omitempty" protobuf:"bytes,2,opt,name=pre"` - // Mid is a lifecycle hook which is executed while the deployment is scaled down to zero before the first new + // 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. Mid *LifecycleHook `json:"mid,omitempty" protobuf:"bytes,3,opt,name=mid"` - // Post is a lifecycle hook which is executed after the strategy has + // post is a lifecycle hook which is executed after the strategy has // finished all deployment logic. All LifecycleHookFailurePolicy values are supported. Post *LifecycleHook `json:"post,omitempty" protobuf:"bytes,4,opt,name=post"` } @@ -159,16 +159,16 @@ type RecreateDeploymentStrategyParams struct { // RollingDeploymentStrategyParams are the input to the Rolling deployment // strategy. type RollingDeploymentStrategyParams struct { - // UpdatePeriodSeconds is the time to wait between individual pod updates. + // updatePeriodSeconds is the time to wait between individual pod updates. // If the value is nil, a default will be used. UpdatePeriodSeconds *int64 `json:"updatePeriodSeconds,omitempty" protobuf:"varint,1,opt,name=updatePeriodSeconds"` - // IntervalSeconds is the time to wait between polling deployment status + // intervalSeconds is the time to wait between polling deployment status // after update. If the value is nil, a default will be used. IntervalSeconds *int64 `json:"intervalSeconds,omitempty" protobuf:"varint,2,opt,name=intervalSeconds"` - // TimeoutSeconds is the time to wait for updates before giving up. If the + // timeoutSeconds is the time to wait for updates before giving up. If the // value is nil, a default will be used. TimeoutSeconds *int64 `json:"timeoutSeconds,omitempty" protobuf:"varint,3,opt,name=timeoutSeconds"` - // MaxUnavailable is the maximum number of pods that can be unavailable + // 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. @@ -181,7 +181,7 @@ type RollingDeploymentStrategyParams struct { // ensuring that at least 70% of original number of pods are available at // all times during the update. MaxUnavailable *intstr.IntOrString `json:"maxUnavailable,omitempty" protobuf:"bytes,4,opt,name=maxUnavailable"` - // MaxSurge is the maximum number of pods that can be scheduled above the + // 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. @@ -194,10 +194,10 @@ type RollingDeploymentStrategyParams struct { // pods running at any time during the update is atmost 130% of original // pods. MaxSurge *intstr.IntOrString `json:"maxSurge,omitempty" protobuf:"bytes,5,opt,name=maxSurge"` - // Pre is a lifecycle hook which is executed before the deployment process + // pre is a lifecycle hook which is executed before the deployment process // begins. All LifecycleHookFailurePolicy values are supported. Pre *LifecycleHook `json:"pre,omitempty" protobuf:"bytes,7,opt,name=pre"` - // Post is a lifecycle hook which is executed after the strategy has + // post is a lifecycle hook which is executed after the strategy has // finished all deployment logic. All LifecycleHookFailurePolicy values // are supported. Post *LifecycleHook `json:"post,omitempty" protobuf:"bytes,8,opt,name=post"` @@ -205,13 +205,13 @@ type RollingDeploymentStrategyParams struct { // LifecycleHook defines a specific deployment lifecycle action. Only one type of action may be specified at any time. type LifecycleHook struct { - // FailurePolicy specifies what action to take if the hook fails. + // failurePolicy specifies what action to take if the hook fails. FailurePolicy LifecycleHookFailurePolicy `json:"failurePolicy" protobuf:"bytes,1,opt,name=failurePolicy,casttype=LifecycleHookFailurePolicy"` - // ExecNewPod specifies the options for a lifecycle hook backed by a pod. + // execNewPod specifies the options for a lifecycle hook backed by a pod. ExecNewPod *ExecNewPodHook `json:"execNewPod,omitempty" protobuf:"bytes,2,opt,name=execNewPod"` - // TagImages instructs the deployer to tag the current image referenced under a container onto an image stream tag. + // tagImages instructs the deployer to tag the current image referenced under a container onto an image stream tag. TagImages []TagImageHook `json:"tagImages,omitempty" protobuf:"bytes,3,rep,name=tagImages"` } @@ -231,14 +231,14 @@ const ( // based on the specified container which is assumed to be part of the // deployment template. type ExecNewPodHook struct { - // Command is the action command and its arguments. + // command is the action command and its arguments. Command []string `json:"command" protobuf:"bytes,1,rep,name=command"` - // Env is a set of environment variables to supply to the hook pod's container. + // env is a set of environment variables to supply to the hook pod's container. Env []corev1.EnvVar `json:"env,omitempty" protobuf:"bytes,2,rep,name=env"` - // ContainerName is the name of a container in the deployment pod template + // containerName is the name of a container in the deployment pod template // whose container image will be used for the hook pod's container. ContainerName string `json:"containerName" protobuf:"bytes,3,opt,name=containerName"` - // Volumes is a list of named volumes from the pod template which should be + // 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. Volumes []string `json:"volumes,omitempty" protobuf:"bytes,4,rep,name=volumes"` @@ -246,10 +246,10 @@ type ExecNewPodHook struct { // TagImageHook is a request to tag the image in a particular container onto an ImageStreamTag. type TagImageHook struct { - // 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 + // 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. ContainerName string `json:"containerName" protobuf:"bytes,1,opt,name=containerName"` - // To is the target ImageStreamTag to set the container's image onto. + // to is the target ImageStreamTag to set the container's image onto. To corev1.ObjectReference `json:"to" protobuf:"bytes,2,opt,name=to"` } @@ -264,9 +264,9 @@ func (t DeploymentTriggerPolicies) String() string { // DeploymentTriggerPolicy describes a policy for a single trigger that results in a new deployment. type DeploymentTriggerPolicy struct { - // Type of the trigger + // type of the trigger Type DeploymentTriggerType `json:"type,omitempty" protobuf:"bytes,1,opt,name=type,casttype=DeploymentTriggerType"` - // ImageChangeParams represents the parameters for the ImageChange trigger. + // imageChangeParams represents the parameters for the ImageChange trigger. ImageChangeParams *DeploymentTriggerImageChangeParams `json:"imageChangeParams,omitempty" protobuf:"bytes,2,opt,name=imageChangeParams"` } @@ -284,42 +284,42 @@ const ( // DeploymentTriggerImageChangeParams represents the parameters to the ImageChange trigger. type DeploymentTriggerImageChangeParams struct { - // Automatic means that the detection of a new tag value should result in an image update + // automatic means that the detection of a new tag value should result in an image update // inside the pod template. Automatic bool `json:"automatic,omitempty" protobuf:"varint,1,opt,name=automatic"` - // ContainerNames is used to restrict tag updates to the specified set of container names in a pod. + // 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. ContainerNames []string `json:"containerNames,omitempty" protobuf:"bytes,2,rep,name=containerNames"` - // From is a reference to an image stream tag to watch for changes. From.Name is the only + // 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. From corev1.ObjectReference `json:"from" protobuf:"bytes,3,opt,name=from"` - // LastTriggeredImage is the last image to be triggered. + // lastTriggeredImage is the last image to be triggered. LastTriggeredImage string `json:"lastTriggeredImage,omitempty" protobuf:"bytes,4,opt,name=lastTriggeredImage"` } // DeploymentConfigStatus represents the current deployment state. type DeploymentConfigStatus struct { - // LatestVersion is used to determine whether the current deployment associated with a deployment + // latestVersion is used to determine whether the current deployment associated with a deployment // config is out of sync. LatestVersion int64 `json:"latestVersion" protobuf:"varint,1,opt,name=latestVersion"` - // ObservedGeneration is the most recent generation observed by the deployment config controller. + // observedGeneration is the most recent generation observed by the deployment config controller. ObservedGeneration int64 `json:"observedGeneration" protobuf:"varint,2,opt,name=observedGeneration"` - // Replicas is the total number of pods targeted by this deployment config. + // replicas is the total number of pods targeted by this deployment config. Replicas int32 `json:"replicas" protobuf:"varint,3,opt,name=replicas"` - // UpdatedReplicas is the total number of non-terminated pods targeted by this deployment config + // updatedReplicas is the total number of non-terminated pods targeted by this deployment config // that have the desired template spec. UpdatedReplicas int32 `json:"updatedReplicas" protobuf:"varint,4,opt,name=updatedReplicas"` - // AvailableReplicas is the total number of available pods targeted by this deployment config. + // availableReplicas is the total number of available pods targeted by this deployment config. AvailableReplicas int32 `json:"availableReplicas" protobuf:"varint,5,opt,name=availableReplicas"` - // UnavailableReplicas is the total number of unavailable pods targeted by this deployment config. + // unavailableReplicas is the total number of unavailable pods targeted by this deployment config. UnavailableReplicas int32 `json:"unavailableReplicas" protobuf:"varint,6,opt,name=unavailableReplicas"` - // Details are the reasons for the update to this deployment config. + // 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 Details *DeploymentDetails `json:"details,omitempty" protobuf:"bytes,7,opt,name=details"` - // Conditions represents the latest available observations of a deployment config's current state. + // conditions represents the latest available observations of a deployment config's current state. // +patchMergeKey=type // +patchStrategy=merge Conditions []DeploymentCondition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,8,rep,name=conditions"` @@ -329,24 +329,24 @@ type DeploymentConfigStatus struct { // DeploymentDetails captures information about the causes of a deployment. type DeploymentDetails struct { - // Message is the user specified change message, if this deployment was triggered manually by the user + // message is the user specified change message, if this deployment was triggered manually by the user Message string `json:"message,omitempty" protobuf:"bytes,1,opt,name=message"` - // Causes are extended data associated with all the causes for creating a new deployment + // causes are extended data associated with all the causes for creating a new deployment Causes []DeploymentCause `json:"causes" protobuf:"bytes,2,rep,name=causes"` } // DeploymentCause captures information about a particular cause of a deployment. type DeploymentCause struct { - // Type of the trigger that resulted in the creation of a new deployment + // type of the trigger that resulted in the creation of a new deployment Type DeploymentTriggerType `json:"type" protobuf:"bytes,1,opt,name=type,casttype=DeploymentTriggerType"` - // ImageTrigger contains the image trigger details, if this trigger was fired based on an image change + // imageTrigger contains the image trigger details, if this trigger was fired based on an image change ImageTrigger *DeploymentCauseImageTrigger `json:"imageTrigger,omitempty" protobuf:"bytes,2,opt,name=imageTrigger"` } // DeploymentCauseImageTrigger represents details about the cause of a deployment originating // from an image change trigger type DeploymentCauseImageTrigger struct { - // From is a reference to the changed object which triggered a deployment. The field may have + // from is a reference to the changed object which triggered a deployment. The field may have // the kinds DockerImage, ImageStreamTag, or ImageStreamImage. From corev1.ObjectReference `json:"from" protobuf:"bytes,1,opt,name=from"` } @@ -381,9 +381,9 @@ const ( // DeploymentCondition describes the state of a deployment config at a certain point. type DeploymentCondition struct { - // Type of deployment condition. + // type of deployment condition. Type DeploymentConditionType `json:"type" protobuf:"bytes,1,opt,name=type,casttype=DeploymentConditionType"` - // Status of the condition, one of True, False, Unknown. + // status of the condition, one of True, False, Unknown. Status corev1.ConditionStatus `json:"status" protobuf:"bytes,2,opt,name=status,casttype=k8s.io/kubernetes/pkg/api/v1.ConditionStatus"` // The last time this condition was updated. LastUpdateTime metav1.Time `json:"lastUpdateTime,omitempty" protobuf:"bytes,6,opt,name=lastUpdateTime"` @@ -411,7 +411,7 @@ type DeploymentConfigList struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` - // Items is a list of deployment configs + // items is a list of deployment configs Items []DeploymentConfig `json:"items" protobuf:"bytes,2,rep,name=items"` } @@ -426,27 +426,27 @@ type DeploymentConfigList struct { // +openshift:compatibility-gen:level=1 type DeploymentConfigRollback struct { metav1.TypeMeta `json:",inline"` - // Name of the deployment config that will be rolled back. + // name of the deployment config that will be rolled back. Name string `json:"name" protobuf:"bytes,1,opt,name=name"` - // UpdatedAnnotations is a set of new annotations that will be added in the deployment config. + // updatedAnnotations is a set of new annotations that will be added in the deployment config. UpdatedAnnotations map[string]string `json:"updatedAnnotations,omitempty" protobuf:"bytes,2,rep,name=updatedAnnotations"` - // Spec defines the options to rollback generation. + // spec defines the options to rollback generation. Spec DeploymentConfigRollbackSpec `json:"spec" protobuf:"bytes,3,opt,name=spec"` } // DeploymentConfigRollbackSpec represents the options for rollback generation. type DeploymentConfigRollbackSpec struct { - // From points to a ReplicationController which is a deployment. + // from points to a ReplicationController which is a deployment. From corev1.ObjectReference `json:"from" protobuf:"bytes,1,opt,name=from"` - // Revision to rollback to. If set to 0, rollback to the last revision. + // revision to rollback to. If set to 0, rollback to the last revision. Revision int64 `json:"revision,omitempty" protobuf:"varint,2,opt,name=revision"` - // IncludeTriggers specifies whether to include config Triggers. + // includeTriggers specifies whether to include config Triggers. IncludeTriggers bool `json:"includeTriggers" protobuf:"varint,3,opt,name=includeTriggers"` - // IncludeTemplate specifies whether to include the PodTemplateSpec. + // includeTemplate specifies whether to include the PodTemplateSpec. IncludeTemplate bool `json:"includeTemplate" protobuf:"varint,4,opt,name=includeTemplate"` - // IncludeReplicationMeta specifies whether to include the replica count and selector. + // includeReplicationMeta specifies whether to include the replica count and selector. IncludeReplicationMeta bool `json:"includeReplicationMeta" protobuf:"varint,5,opt,name=includeReplicationMeta"` - // IncludeStrategy specifies whether to include the deployment Strategy. + // includeStrategy specifies whether to include the deployment Strategy. IncludeStrategy bool `json:"includeStrategy" protobuf:"varint,6,opt,name=includeStrategy"` } @@ -461,14 +461,14 @@ type DeploymentConfigRollbackSpec struct { // +openshift:compatibility-gen:level=1 type DeploymentRequest struct { metav1.TypeMeta `json:",inline"` - // Name of the deployment config for requesting a new deployment. + // name of the deployment config for requesting a new deployment. Name string `json:"name" protobuf:"bytes,1,opt,name=name"` - // Latest will update the deployment config with the latest state from all triggers. + // latest will update the deployment config with the latest state from all triggers. Latest bool `json:"latest" protobuf:"varint,2,opt,name=latest"` - // Force will try to force a new deployment to run. If the deployment config is paused, + // 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. Force bool `json:"force" protobuf:"varint,3,opt,name=force"` - // ExcludeTriggers instructs the instantiator to avoid processing the specified triggers. + // 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. ExcludeTriggers []DeploymentTriggerType `json:"excludeTriggers,omitempty" protobuf:"bytes,4,rep,name=excludeTriggers,casttype=DeploymentTriggerType"` @@ -501,7 +501,7 @@ type DeploymentLogOptions struct { // The container for which to stream logs. Defaults to only container if there is one container in the pod. Container string `json:"container,omitempty" protobuf:"bytes,1,opt,name=container"` - // Follow if true indicates that the build log should be streamed until + // follow if true indicates that the build log should be streamed until // the build terminates. Follow bool `json:"follow,omitempty" protobuf:"varint,2,opt,name=follow"` // Return previous deployment logs. Defaults to false. @@ -527,11 +527,11 @@ type DeploymentLogOptions struct { // slightly more or slightly less than the specified limit. LimitBytes *int64 `json:"limitBytes,omitempty" protobuf:"varint,8,opt,name=limitBytes"` - // NoWait if true causes the call to return immediately even if the deployment + // 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. // TODO: Fix the tag to 'noWait' in v2 NoWait bool `json:"nowait,omitempty" protobuf:"varint,9,opt,name=nowait"` - // Version of the deployment for which to view logs. + // version of the deployment for which to view logs. Version *int64 `json:"version,omitempty" protobuf:"varint,10,opt,name=version"` } diff --git a/apps/v1/zz_generated.swagger_doc_generated.go b/apps/v1/zz_generated.swagger_doc_generated.go index ab137d59bee..55b53c5daf2 100644 --- a/apps/v1/zz_generated.swagger_doc_generated.go +++ b/apps/v1/zz_generated.swagger_doc_generated.go @@ -13,9 +13,9 @@ package v1 // AUTO-GENERATED FUNCTIONS START HERE var map_CustomDeploymentStrategyParams = map[string]string{ "": "CustomDeploymentStrategyParams are the input to the Custom deployment strategy.", - "image": "Image specifies a container image which can carry out a deployment.", - "environment": "Environment holds the environment which will be given to the container for Image.", - "command": "Command is optional and overrides CMD in the container Image.", + "image": "image specifies a container image which can carry out a deployment.", + "environment": "environment holds the environment which will be given to the container for Image.", + "command": "command is optional and overrides CMD in the container Image.", } func (CustomDeploymentStrategyParams) SwaggerDoc() map[string]string { @@ -24,8 +24,8 @@ func (CustomDeploymentStrategyParams) SwaggerDoc() map[string]string { var map_DeploymentCause = map[string]string{ "": "DeploymentCause captures information about a particular cause of a deployment.", - "type": "Type of the trigger that resulted in the creation of a new deployment", - "imageTrigger": "ImageTrigger contains the image trigger details, if this trigger was fired based on an image change", + "type": "type of the trigger that resulted in the creation of a new deployment", + "imageTrigger": "imageTrigger contains the image trigger details, if this trigger was fired based on an image change", } func (DeploymentCause) SwaggerDoc() map[string]string { @@ -34,7 +34,7 @@ func (DeploymentCause) SwaggerDoc() map[string]string { var map_DeploymentCauseImageTrigger = map[string]string{ "": "DeploymentCauseImageTrigger represents details about the cause of a deployment originating from an image change trigger", - "from": "From is a reference to the changed object which triggered a deployment. The field may have the kinds DockerImage, ImageStreamTag, or ImageStreamImage.", + "from": "from is a reference to the changed object which triggered a deployment. The field may have the kinds DockerImage, ImageStreamTag, or ImageStreamImage.", } func (DeploymentCauseImageTrigger) SwaggerDoc() map[string]string { @@ -43,8 +43,8 @@ func (DeploymentCauseImageTrigger) SwaggerDoc() map[string]string { var map_DeploymentCondition = map[string]string{ "": "DeploymentCondition describes the state of a deployment config at a certain point.", - "type": "Type of deployment condition.", - "status": "Status of the condition, one of True, False, Unknown.", + "type": "type of deployment condition.", + "status": "status of the condition, one of True, False, Unknown.", "lastUpdateTime": "The last time this condition was updated.", "lastTransitionTime": "The last time the condition transitioned from one status to another.", "reason": "The reason for the condition's last transition.", @@ -58,8 +58,8 @@ func (DeploymentCondition) SwaggerDoc() map[string]string { var map_DeploymentConfig = map[string]string{ "": "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.", "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "spec": "Spec represents a desired deployment state and how to deploy to it.", - "status": "Status represents the current deployment state.", + "spec": "spec represents a desired deployment state and how to deploy to it.", + "status": "status represents the current deployment state.", } func (DeploymentConfig) SwaggerDoc() map[string]string { @@ -69,7 +69,7 @@ func (DeploymentConfig) SwaggerDoc() map[string]string { var map_DeploymentConfigList = map[string]string{ "": "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).", "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "items": "Items is a list of deployment configs", + "items": "items is a list of deployment configs", } func (DeploymentConfigList) SwaggerDoc() map[string]string { @@ -78,9 +78,9 @@ func (DeploymentConfigList) SwaggerDoc() map[string]string { var map_DeploymentConfigRollback = map[string]string{ "": "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).", - "name": "Name of the deployment config that will be rolled back.", - "updatedAnnotations": "UpdatedAnnotations is a set of new annotations that will be added in the deployment config.", - "spec": "Spec defines the options to rollback generation.", + "name": "name of the deployment config that will be rolled back.", + "updatedAnnotations": "updatedAnnotations is a set of new annotations that will be added in the deployment config.", + "spec": "spec defines the options to rollback generation.", } func (DeploymentConfigRollback) SwaggerDoc() map[string]string { @@ -89,12 +89,12 @@ func (DeploymentConfigRollback) SwaggerDoc() map[string]string { var map_DeploymentConfigRollbackSpec = map[string]string{ "": "DeploymentConfigRollbackSpec represents the options for rollback generation.", - "from": "From points to a ReplicationController which is a deployment.", - "revision": "Revision to rollback to. If set to 0, rollback to the last revision.", - "includeTriggers": "IncludeTriggers specifies whether to include config Triggers.", - "includeTemplate": "IncludeTemplate specifies whether to include the PodTemplateSpec.", - "includeReplicationMeta": "IncludeReplicationMeta specifies whether to include the replica count and selector.", - "includeStrategy": "IncludeStrategy specifies whether to include the deployment Strategy.", + "from": "from points to a ReplicationController which is a deployment.", + "revision": "revision to rollback to. If set to 0, rollback to the last revision.", + "includeTriggers": "includeTriggers specifies whether to include config Triggers.", + "includeTemplate": "includeTemplate specifies whether to include the PodTemplateSpec.", + "includeReplicationMeta": "includeReplicationMeta specifies whether to include the replica count and selector.", + "includeStrategy": "includeStrategy specifies whether to include the deployment Strategy.", } func (DeploymentConfigRollbackSpec) SwaggerDoc() map[string]string { @@ -103,15 +103,15 @@ func (DeploymentConfigRollbackSpec) SwaggerDoc() map[string]string { var map_DeploymentConfigSpec = map[string]string{ "": "DeploymentConfigSpec represents the desired state of the deployment.", - "strategy": "Strategy describes how a deployment is executed.", - "minReadySeconds": "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)", - "triggers": "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.", - "replicas": "Replicas is the number of desired replicas.", - "revisionHistoryLimit": "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.)", - "test": "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.", - "paused": "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.", - "selector": "Selector is a label query over pods that should match the Replicas count.", - "template": "Template is the object that describes the pod that will be created if insufficient replicas are detected.", + "strategy": "strategy describes how a deployment is executed.", + "minReadySeconds": "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)", + "triggers": "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.", + "replicas": "replicas is the number of desired replicas.", + "revisionHistoryLimit": "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.)", + "test": "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.", + "paused": "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.", + "selector": "selector is a label query over pods that should match the Replicas count.", + "template": "template is the object that describes the pod that will be created if insufficient replicas are detected.", } func (DeploymentConfigSpec) SwaggerDoc() map[string]string { @@ -120,14 +120,14 @@ func (DeploymentConfigSpec) SwaggerDoc() map[string]string { var map_DeploymentConfigStatus = map[string]string{ "": "DeploymentConfigStatus represents the current deployment state.", - "latestVersion": "LatestVersion is used to determine whether the current deployment associated with a deployment config is out of sync.", - "observedGeneration": "ObservedGeneration is the most recent generation observed by the deployment config controller.", - "replicas": "Replicas is the total number of pods targeted by this deployment config.", - "updatedReplicas": "UpdatedReplicas is the total number of non-terminated pods targeted by this deployment config that have the desired template spec.", - "availableReplicas": "AvailableReplicas is the total number of available pods targeted by this deployment config.", - "unavailableReplicas": "UnavailableReplicas is the total number of unavailable pods targeted by this deployment config.", - "details": "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", - "conditions": "Conditions represents the latest available observations of a deployment config's current state.", + "latestVersion": "latestVersion is used to determine whether the current deployment associated with a deployment config is out of sync.", + "observedGeneration": "observedGeneration is the most recent generation observed by the deployment config controller.", + "replicas": "replicas is the total number of pods targeted by this deployment config.", + "updatedReplicas": "updatedReplicas is the total number of non-terminated pods targeted by this deployment config that have the desired template spec.", + "availableReplicas": "availableReplicas is the total number of available pods targeted by this deployment config.", + "unavailableReplicas": "unavailableReplicas is the total number of unavailable pods targeted by this deployment config.", + "details": "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", + "conditions": "conditions represents the latest available observations of a deployment config's current state.", "readyReplicas": "Total number of ready pods targeted by this deployment.", } @@ -137,8 +137,8 @@ func (DeploymentConfigStatus) SwaggerDoc() map[string]string { var map_DeploymentDetails = map[string]string{ "": "DeploymentDetails captures information about the causes of a deployment.", - "message": "Message is the user specified change message, if this deployment was triggered manually by the user", - "causes": "Causes are extended data associated with all the causes for creating a new deployment", + "message": "message is the user specified change message, if this deployment was triggered manually by the user", + "causes": "causes are extended data associated with all the causes for creating a new deployment", } func (DeploymentDetails) SwaggerDoc() map[string]string { @@ -156,15 +156,15 @@ func (DeploymentLog) SwaggerDoc() map[string]string { var map_DeploymentLogOptions = map[string]string{ "": "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).", "container": "The container for which to stream logs. Defaults to only container if there is one container in the pod.", - "follow": "Follow if true indicates that the build log should be streamed until the build terminates.", + "follow": "follow if true indicates that the build log should be streamed until the build terminates.", "previous": "Return previous deployment logs. Defaults to false.", "sinceSeconds": "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.", "sinceTime": "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.", "timestamps": "If true, add an RFC3339 or RFC3339Nano timestamp at the beginning of every line of log output. Defaults to false.", "tailLines": "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", "limitBytes": "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.", - "nowait": "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.", - "version": "Version of the deployment for which to view logs.", + "nowait": "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.", + "version": "version of the deployment for which to view logs.", } func (DeploymentLogOptions) SwaggerDoc() map[string]string { @@ -173,10 +173,10 @@ func (DeploymentLogOptions) SwaggerDoc() map[string]string { var map_DeploymentRequest = map[string]string{ "": "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).", - "name": "Name of the deployment config for requesting a new deployment.", - "latest": "Latest will update the deployment config with the latest state from all triggers.", - "force": "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.", - "excludeTriggers": "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.", + "name": "name of the deployment config for requesting a new deployment.", + "latest": "latest will update the deployment config with the latest state from all triggers.", + "force": "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.", + "excludeTriggers": "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.", } func (DeploymentRequest) SwaggerDoc() map[string]string { @@ -185,14 +185,14 @@ func (DeploymentRequest) SwaggerDoc() map[string]string { var map_DeploymentStrategy = map[string]string{ "": "DeploymentStrategy describes how to perform a deployment.", - "type": "Type is the name of a deployment strategy.", - "customParams": "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.", - "recreateParams": "RecreateParams are the input to the Recreate deployment strategy.", - "rollingParams": "RollingParams are the input to the Rolling deployment strategy.", - "resources": "Resources contains resource requirements to execute the deployment and any hooks.", - "labels": "Labels is a set of key, value pairs added to custom deployer and lifecycle pre/post hook pods.", - "annotations": "Annotations is a set of key, value pairs added to custom deployer and lifecycle pre/post hook pods.", - "activeDeadlineSeconds": "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": "type is the name of a deployment strategy.", + "customParams": "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.", + "recreateParams": "recreateParams are the input to the Recreate deployment strategy.", + "rollingParams": "rollingParams are the input to the Rolling deployment strategy.", + "resources": "resources contains resource requirements to execute the deployment and any hooks.", + "labels": "labels is a set of key, value pairs added to custom deployer and lifecycle pre/post hook pods.", + "annotations": "annotations is a set of key, value pairs added to custom deployer and lifecycle pre/post hook pods.", + "activeDeadlineSeconds": "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.", } func (DeploymentStrategy) SwaggerDoc() map[string]string { @@ -201,10 +201,10 @@ func (DeploymentStrategy) SwaggerDoc() map[string]string { var map_DeploymentTriggerImageChangeParams = map[string]string{ "": "DeploymentTriggerImageChangeParams represents the parameters to the ImageChange trigger.", - "automatic": "Automatic means that the detection of a new tag value should result in an image update inside the pod template.", - "containerNames": "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.", - "from": "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.", - "lastTriggeredImage": "LastTriggeredImage is the last image to be triggered.", + "automatic": "automatic means that the detection of a new tag value should result in an image update inside the pod template.", + "containerNames": "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.", + "from": "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.", + "lastTriggeredImage": "lastTriggeredImage is the last image to be triggered.", } func (DeploymentTriggerImageChangeParams) SwaggerDoc() map[string]string { @@ -213,8 +213,8 @@ func (DeploymentTriggerImageChangeParams) SwaggerDoc() map[string]string { var map_DeploymentTriggerPolicy = map[string]string{ "": "DeploymentTriggerPolicy describes a policy for a single trigger that results in a new deployment.", - "type": "Type of the trigger", - "imageChangeParams": "ImageChangeParams represents the parameters for the ImageChange trigger.", + "type": "type of the trigger", + "imageChangeParams": "imageChangeParams represents the parameters for the ImageChange trigger.", } func (DeploymentTriggerPolicy) SwaggerDoc() map[string]string { @@ -223,10 +223,10 @@ func (DeploymentTriggerPolicy) SwaggerDoc() map[string]string { var map_ExecNewPodHook = map[string]string{ "": "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.", - "command": "Command is the action command and its arguments.", - "env": "Env is a set of environment variables to supply to the hook pod's container.", - "containerName": "ContainerName is the name of a container in the deployment pod template whose container image will be used for the hook pod's container.", - "volumes": "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.", + "command": "command is the action command and its arguments.", + "env": "env is a set of environment variables to supply to the hook pod's container.", + "containerName": "containerName is the name of a container in the deployment pod template whose container image will be used for the hook pod's container.", + "volumes": "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.", } func (ExecNewPodHook) SwaggerDoc() map[string]string { @@ -235,9 +235,9 @@ func (ExecNewPodHook) SwaggerDoc() map[string]string { var map_LifecycleHook = map[string]string{ "": "LifecycleHook defines a specific deployment lifecycle action. Only one type of action may be specified at any time.", - "failurePolicy": "FailurePolicy specifies what action to take if the hook fails.", - "execNewPod": "ExecNewPod specifies the options for a lifecycle hook backed by a pod.", - "tagImages": "TagImages instructs the deployer to tag the current image referenced under a container onto an image stream tag.", + "failurePolicy": "failurePolicy specifies what action to take if the hook fails.", + "execNewPod": "execNewPod specifies the options for a lifecycle hook backed by a pod.", + "tagImages": "tagImages instructs the deployer to tag the current image referenced under a container onto an image stream tag.", } func (LifecycleHook) SwaggerDoc() map[string]string { @@ -246,10 +246,10 @@ func (LifecycleHook) SwaggerDoc() map[string]string { var map_RecreateDeploymentStrategyParams = map[string]string{ "": "RecreateDeploymentStrategyParams are the input to the Recreate deployment strategy.", - "timeoutSeconds": "TimeoutSeconds is the time to wait for updates before giving up. If the value is nil, a default will be used.", - "pre": "Pre is a lifecycle hook which is executed before the strategy manipulates the deployment. All LifecycleHookFailurePolicy values are supported.", - "mid": "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.", - "post": "Post is a lifecycle hook which is executed after the strategy has finished all deployment logic. All LifecycleHookFailurePolicy values are supported.", + "timeoutSeconds": "timeoutSeconds is the time to wait for updates before giving up. If the value is nil, a default will be used.", + "pre": "pre is a lifecycle hook which is executed before the strategy manipulates the deployment. All LifecycleHookFailurePolicy values are supported.", + "mid": "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.", + "post": "post is a lifecycle hook which is executed after the strategy has finished all deployment logic. All LifecycleHookFailurePolicy values are supported.", } func (RecreateDeploymentStrategyParams) SwaggerDoc() map[string]string { @@ -258,13 +258,13 @@ func (RecreateDeploymentStrategyParams) SwaggerDoc() map[string]string { var map_RollingDeploymentStrategyParams = map[string]string{ "": "RollingDeploymentStrategyParams are the input to the Rolling deployment strategy.", - "updatePeriodSeconds": "UpdatePeriodSeconds is the time to wait between individual pod updates. If the value is nil, a default will be used.", - "intervalSeconds": "IntervalSeconds is the time to wait between polling deployment status after update. If the value is nil, a default will be used.", - "timeoutSeconds": "TimeoutSeconds is the time to wait for updates before giving up. If the value is nil, a default will be used.", - "maxUnavailable": "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.", - "maxSurge": "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.", - "pre": "Pre is a lifecycle hook which is executed before the deployment process begins. All LifecycleHookFailurePolicy values are supported.", - "post": "Post is a lifecycle hook which is executed after the strategy has finished all deployment logic. All LifecycleHookFailurePolicy values are supported.", + "updatePeriodSeconds": "updatePeriodSeconds is the time to wait between individual pod updates. If the value is nil, a default will be used.", + "intervalSeconds": "intervalSeconds is the time to wait between polling deployment status after update. If the value is nil, a default will be used.", + "timeoutSeconds": "timeoutSeconds is the time to wait for updates before giving up. If the value is nil, a default will be used.", + "maxUnavailable": "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.", + "maxSurge": "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.", + "pre": "pre is a lifecycle hook which is executed before the deployment process begins. All LifecycleHookFailurePolicy values are supported.", + "post": "post is a lifecycle hook which is executed after the strategy has finished all deployment logic. All LifecycleHookFailurePolicy values are supported.", } func (RollingDeploymentStrategyParams) SwaggerDoc() map[string]string { @@ -273,8 +273,8 @@ func (RollingDeploymentStrategyParams) SwaggerDoc() map[string]string { var map_TagImageHook = map[string]string{ "": "TagImageHook is a request to tag the image in a particular container onto an ImageStreamTag.", - "containerName": "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.", - "to": "To is the target ImageStreamTag to set the container's image onto.", + "containerName": "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.", + "to": "to is the target ImageStreamTag to set the container's image onto.", } func (TagImageHook) SwaggerDoc() map[string]string { diff --git a/authorization/v1/generated.proto b/authorization/v1/generated.proto index 28e4e8ce62b..f7d7b772a7f 100644 --- a/authorization/v1/generated.proto +++ b/authorization/v1/generated.proto @@ -16,10 +16,10 @@ option go_package = "github.com/openshift/api/authorization/v1"; // Action describes a request to the API server message Action { - // Namespace is the namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces + // namespace is the namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces optional string namespace = 1; - // Verb is one of: get, list, watch, create, update, delete + // verb is one of: get, list, watch, create, update, delete optional string verb = 2; // Group is the API group of the resource @@ -30,19 +30,19 @@ message Action { // Serialized as resourceAPIVersion to avoid confusion with TypeMeta.apiVersion and ObjectMeta.resourceVersion when inlined optional string resourceAPIVersion = 4; - // Resource is one of the existing resource types + // resource is one of the existing resource types optional string resource = 5; - // ResourceName is the name of the resource being requested for a "get" or deleted for a "delete" + // resourceName is the name of the resource being requested for a "get" or deleted for a "delete" optional string resourceName = 6; - // Path is the path of a non resource URL + // path is the path of a non resource URL optional string path = 8; - // IsNonResourceURL is true if this is a request for a non-resource URL (outside of the resource hierarchy) + // isNonResourceURL is true if this is a request for a non-resource URL (outside of the resource hierarchy) optional bool isNonResourceURL = 9; - // Content is the actual content of the request for create and update + // content is the actual content of the request for create and update // +kubebuilder:pruning:PreserveUnknownFields optional .k8s.io.apimachinery.pkg.runtime.RawExtension content = 7; } @@ -56,10 +56,10 @@ message ClusterRole { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata optional .k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1; - // Rules holds all the PolicyRules for this ClusterRole + // rules holds all the PolicyRules for this ClusterRole repeated PolicyRule rules = 2; - // AggregationRule is an optional field that describes how to build the Rules for this ClusterRole. + // 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. optional .k8s.io.api.rbac.v1.AggregationRule aggregationRule = 3; @@ -76,28 +76,28 @@ message ClusterRoleBinding { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata optional .k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1; - // UserNames holds all the usernames directly bound to the role. + // 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. // +k8s:conversion-gen=false // +optional optional OptionalNames userNames = 2; - // GroupNames holds all the groups directly bound to the role. + // 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. // +k8s:conversion-gen=false // +optional optional OptionalNames groupNames = 3; - // Subjects hold object references to authorize with this rule. + // 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. repeated .k8s.io.api.core.v1.ObjectReference subjects = 4; - // RoleRef can only reference the current namespace and the global namespace. + // 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. optional .k8s.io.api.core.v1.ObjectReference roleRef = 5; @@ -112,7 +112,7 @@ message ClusterRoleBindingList { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata optional .k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1; - // Items is a list of ClusterRoleBindings + // items is a list of ClusterRoleBindings repeated ClusterRoleBinding items = 2; } @@ -125,14 +125,14 @@ message ClusterRoleList { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata optional .k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1; - // Items is a list of ClusterRoles + // items is a list of ClusterRoles repeated ClusterRole items = 2; } // GroupRestriction matches a group either by a string match on the group name // or a label selector applied to group labels. message GroupRestriction { - // Groups is a list of groups used to match against an individual user's + // 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. // +nullable @@ -175,14 +175,14 @@ message LocalSubjectAccessReview { // Action describes the action being tested. The Namespace element is FORCED to the current namespace. optional Action Action = 1; - // User is optional. If both User and Groups are empty, the current authenticated user is used. + // user is optional. If both User and Groups are empty, the current authenticated user is used. optional string user = 2; - // Groups is optional. Groups is the list of groups to which the User belongs. + // groups is optional. Groups is the list of groups to which the User belongs. // +k8s:conversion-gen=false repeated string groups = 3; - // Scopes to use for the evaluation. Empty means "use the unscoped (full) permissions of the user/groups". + // 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. // +k8s:conversion-gen=false @@ -191,37 +191,37 @@ message LocalSubjectAccessReview { // NamedClusterRole relates a name with a cluster role message NamedClusterRole { - // Name is the name of the cluster role + // name is the name of the cluster role optional string name = 1; - // Role is the cluster role being named + // role is the cluster role being named optional ClusterRole role = 2; } // NamedClusterRoleBinding relates a name with a cluster role binding message NamedClusterRoleBinding { - // Name is the name of the cluster role binding + // name is the name of the cluster role binding optional string name = 1; - // RoleBinding is the cluster role binding being named + // roleBinding is the cluster role binding being named optional ClusterRoleBinding roleBinding = 2; } // NamedRole relates a Role with a name message NamedRole { - // Name is the name of the role + // name is the name of the role optional string name = 1; - // Role is the role being named + // role is the role being named optional Role role = 2; } // NamedRoleBinding relates a role binding with a name message NamedRoleBinding { - // Name is the name of the role binding + // name is the name of the role binding optional string name = 1; - // RoleBinding is the role binding being named + // roleBinding is the role binding being named optional RoleBinding roleBinding = 2; } @@ -246,25 +246,25 @@ message OptionalScopes { // 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. message PolicyRule { - // Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. VerbAll represents all kinds. + // verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. VerbAll represents all kinds. repeated string verbs = 1; - // AttributeRestrictions will vary depending on what the Authorizer/AuthorizationAttributeBuilder pair supports. + // 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. // +kubebuilder:pruning:PreserveUnknownFields optional .k8s.io.apimachinery.pkg.runtime.RawExtension attributeRestrictions = 2; - // 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. + // 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 // +optional // +nullable repeated string apiGroups = 3; - // Resources is a list of resources this rule applies to. ResourceAll represents all resources. + // resources is a list of resources this rule applies to. ResourceAll represents all resources. repeated string resources = 4; - // ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed. + // resourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed. repeated string resourceNames = 5; // 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 @@ -291,7 +291,7 @@ message ResourceAccessReview { // Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). // +openshift:compatibility-gen:level=1 message ResourceAccessReviewResponse { - // Namespace is the namespace used for the access review + // namespace is the namespace used for the access review optional string namespace = 1; // UsersSlice is the list of users who can perform the action @@ -317,7 +317,7 @@ message Role { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata optional .k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1; - // Rules holds all the PolicyRules for this Role + // rules holds all the PolicyRules for this Role repeated PolicyRule rules = 2; } @@ -332,28 +332,28 @@ message RoleBinding { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata optional .k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1; - // UserNames holds all the usernames directly bound to the role. + // 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. // +k8s:conversion-gen=false // +optional optional OptionalNames userNames = 2; - // GroupNames holds all the groups directly bound to the role. + // 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. // +k8s:conversion-gen=false // +optional optional OptionalNames groupNames = 3; - // Subjects hold object references to authorize with this rule. + // 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. repeated .k8s.io.api.core.v1.ObjectReference subjects = 4; - // RoleRef can only reference the current namespace and the global namespace. + // 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. optional .k8s.io.api.core.v1.ObjectReference roleRef = 5; @@ -368,7 +368,7 @@ message RoleBindingList { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata optional .k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1; - // Items is a list of RoleBindings + // items is a list of RoleBindings repeated RoleBinding items = 2; } @@ -390,7 +390,7 @@ message RoleBindingRestriction { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata optional .k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1; - // Spec defines the matcher. + // spec defines the matcher. optional RoleBindingRestrictionSpec spec = 2; } @@ -403,22 +403,22 @@ message RoleBindingRestrictionList { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata optional .k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1; - // Items is a list of RoleBindingRestriction objects. + // items is a list of RoleBindingRestriction objects. repeated RoleBindingRestriction items = 2; } // RoleBindingRestrictionSpec defines a rolebinding restriction. Exactly one // field must be non-nil. message RoleBindingRestrictionSpec { - // UserRestriction matches against user subjects. + // userrestriction matches against user subjects. // +nullable optional UserRestriction userrestriction = 1; - // GroupRestriction matches against group subjects. + // grouprestriction matches against group subjects. // +nullable optional GroupRestriction grouprestriction = 2; - // ServiceAccountRestriction matches against service-account subjects. + // serviceaccountrestriction matches against service-account subjects. // +nullable optional ServiceAccountRestriction serviceaccountrestriction = 3; } @@ -432,7 +432,7 @@ message RoleList { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata optional .k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1; - // Items is a list of Roles + // items is a list of Roles repeated Role items = 2; } @@ -445,16 +445,16 @@ message SelfSubjectRulesReview { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata optional .k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 3; - // Spec adds information about how to conduct the check + // spec adds information about how to conduct the check optional SelfSubjectRulesReviewSpec spec = 1; - // Status is completed by the server to tell which permissions you have + // status is completed by the server to tell which permissions you have optional SubjectRulesReviewStatus status = 2; } // SelfSubjectRulesReviewSpec adds information about how to conduct the check message SelfSubjectRulesReviewSpec { - // Scopes to use for the evaluation. Empty means "use the unscoped (full) permissions of the user/groups". + // 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". // +k8s:conversion-gen=false optional OptionalScopes scopes = 1; @@ -463,10 +463,10 @@ message SelfSubjectRulesReviewSpec { // ServiceAccountReference specifies a service account and namespace by their // names. message ServiceAccountReference { - // Name is the name of the service account. + // name is the name of the service account. optional string name = 1; - // Namespace is the namespace of the service account. Service accounts from + // 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. @@ -477,10 +477,10 @@ message ServiceAccountReference { // either the service-account name or the name of the service account's // namespace. message ServiceAccountRestriction { - // ServiceAccounts specifies a list of literal service-account names. + // serviceaccounts specifies a list of literal service-account names. repeated ServiceAccountReference serviceaccounts = 1; - // Namespaces specifies a list of literal namespace names. + // namespaces specifies a list of literal namespace names. repeated string namespaces = 2; } @@ -496,14 +496,14 @@ message SubjectAccessReview { // Action describes the action being tested. optional Action Action = 1; - // User is optional. If both User and Groups are empty, the current authenticated user is used. + // user is optional. If both User and Groups are empty, the current authenticated user is used. optional string user = 2; // GroupsSlice is optional. Groups is the list of groups to which the User belongs. // +k8s:conversion-gen=false repeated string groups = 3; - // Scopes to use for the evaluation. Empty means "use the unscoped (full) permissions of the user/groups". + // 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. // +k8s:conversion-gen=false @@ -515,16 +515,16 @@ message SubjectAccessReview { // Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). // +openshift:compatibility-gen:level=1 message SubjectAccessReviewResponse { - // Namespace is the namespace used for the access review + // namespace is the namespace used for the access review optional string namespace = 1; - // Allowed is required. True if the action would be allowed, false otherwise. + // allowed is required. True if the action would be allowed, false otherwise. optional bool allowed = 2; - // Reason is optional. It indicates why a request was allowed or denied. + // reason is optional. It indicates why a request was allowed or denied. optional string reason = 3; - // EvaluationError is an indication that some error occurred during the authorization check. + // 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. optional string evaluationError = 4; @@ -539,31 +539,31 @@ message SubjectRulesReview { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata optional .k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 3; - // Spec adds information about how to conduct the check + // spec adds information about how to conduct the check optional SubjectRulesReviewSpec spec = 1; - // Status is completed by the server to tell which permissions you have + // status is completed by the server to tell which permissions you have optional SubjectRulesReviewStatus status = 2; } // SubjectRulesReviewSpec adds information about how to conduct the check message SubjectRulesReviewSpec { - // User is optional. At least one of User and Groups must be specified. + // user is optional. At least one of User and Groups must be specified. optional string user = 1; - // Groups is optional. Groups is the list of groups to which the User belongs. At least one of User and Groups must be specified. + // groups is optional. Groups is the list of groups to which the User belongs. At least one of User and Groups must be specified. repeated string groups = 2; - // Scopes to use for the evaluation. Empty means "use the unscoped (full) permissions of the user/groups". + // scopes to use for the evaluation. Empty means "use the unscoped (full) permissions of the user/groups". optional OptionalScopes scopes = 3; } // SubjectRulesReviewStatus is contains the result of a rules check message SubjectRulesReviewStatus { - // Rules is the list of rules (no particular sort) that are allowed for the subject + // rules is the list of rules (no particular sort) that are allowed for the subject repeated PolicyRule rules = 1; - // EvaluationError can appear in combination with Rules. It means some error happened during evaluation + // evaluationError can appear in combination with Rules. It means some error happened during evaluation // that may have prevented additional rules from being populated. optional string evaluationError = 2; } @@ -572,10 +572,10 @@ message SubjectRulesReviewStatus { // a string match on the name of a group to which the user belongs, or a label // selector applied to the user labels. message UserRestriction { - // Users specifies a list of literal user names. + // users specifies a list of literal user names. repeated string users = 1; - // Groups specifies a list of literal group names. + // groups specifies a list of literal group names. // +nullable repeated string groups = 2; diff --git a/authorization/v1/types.go b/authorization/v1/types.go index e8dd0c29fa3..bf4071867f3 100644 --- a/authorization/v1/types.go +++ b/authorization/v1/types.go @@ -28,21 +28,21 @@ const ( // 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 PolicyRule struct { - // Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. VerbAll represents all kinds. + // verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. VerbAll represents all kinds. Verbs []string `json:"verbs" protobuf:"bytes,1,rep,name=verbs"` - // AttributeRestrictions will vary depending on what the Authorizer/AuthorizationAttributeBuilder pair supports. + // 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. // +kubebuilder:pruning:PreserveUnknownFields AttributeRestrictions kruntime.RawExtension `json:"attributeRestrictions,omitempty" protobuf:"bytes,2,opt,name=attributeRestrictions"` - // 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. + // 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 // +optional // +nullable APIGroups []string `json:"apiGroups,omitempty" protobuf:"bytes,3,rep,name=apiGroups"` - // Resources is a list of resources this rule applies to. ResourceAll represents all resources. + // resources is a list of resources this rule applies to. ResourceAll represents all resources. Resources []string `json:"resources" protobuf:"bytes,4,rep,name=resources"` - // ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed. + // resourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed. ResourceNames []string `json:"resourceNames,omitempty" protobuf:"bytes,5,rep,name=resourceNames"` // 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. @@ -73,7 +73,7 @@ type Role struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` - // Rules holds all the PolicyRules for this Role + // rules holds all the PolicyRules for this Role Rules []PolicyRule `json:"rules" protobuf:"bytes,2,rep,name=rules"` } @@ -102,26 +102,26 @@ type RoleBinding struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` - // UserNames holds all the usernames directly bound to the role. + // 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. // +k8s:conversion-gen=false // +optional UserNames OptionalNames `json:"userNames" protobuf:"bytes,2,rep,name=userNames"` - // GroupNames holds all the groups directly bound to the role. + // 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. // +k8s:conversion-gen=false // +optional GroupNames OptionalNames `json:"groupNames" protobuf:"bytes,3,rep,name=groupNames"` - // Subjects hold object references to authorize with this rule. + // 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. Subjects []corev1.ObjectReference `json:"subjects" protobuf:"bytes,4,rep,name=subjects"` - // RoleRef can only reference the current namespace and the global namespace. + // 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. RoleRef corev1.ObjectReference `json:"roleRef" protobuf:"bytes,5,opt,name=roleRef"` @@ -129,17 +129,17 @@ type RoleBinding struct { // NamedRole relates a Role with a name type NamedRole struct { - // Name is the name of the role + // name is the name of the role Name string `json:"name" protobuf:"bytes,1,opt,name=name"` - // Role is the role being named + // role is the role being named Role Role `json:"role" protobuf:"bytes,2,opt,name=role"` } // NamedRoleBinding relates a role binding with a name type NamedRoleBinding struct { - // Name is the name of the role binding + // name is the name of the role binding Name string `json:"name" protobuf:"bytes,1,opt,name=name"` - // RoleBinding is the role binding being named + // roleBinding is the role binding being named RoleBinding RoleBinding `json:"roleBinding" protobuf:"bytes,2,opt,name=roleBinding"` } @@ -158,16 +158,16 @@ type SelfSubjectRulesReview struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,3,opt,name=metadata"` - // Spec adds information about how to conduct the check + // spec adds information about how to conduct the check Spec SelfSubjectRulesReviewSpec `json:"spec" protobuf:"bytes,1,opt,name=spec"` - // Status is completed by the server to tell which permissions you have + // status is completed by the server to tell which permissions you have Status SubjectRulesReviewStatus `json:"status,omitempty" protobuf:"bytes,2,opt,name=status"` } // SelfSubjectRulesReviewSpec adds information about how to conduct the check type SelfSubjectRulesReviewSpec struct { - // Scopes to use for the evaluation. Empty means "use the unscoped (full) permissions of the user/groups". + // 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". // +k8s:conversion-gen=false Scopes OptionalScopes `json:"scopes" protobuf:"bytes,1,rep,name=scopes"` @@ -188,28 +188,28 @@ type SubjectRulesReview struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,3,opt,name=metadata"` - // Spec adds information about how to conduct the check + // spec adds information about how to conduct the check Spec SubjectRulesReviewSpec `json:"spec" protobuf:"bytes,1,opt,name=spec"` - // Status is completed by the server to tell which permissions you have + // status is completed by the server to tell which permissions you have Status SubjectRulesReviewStatus `json:"status,omitempty" protobuf:"bytes,2,opt,name=status"` } // SubjectRulesReviewSpec adds information about how to conduct the check type SubjectRulesReviewSpec struct { - // User is optional. At least one of User and Groups must be specified. + // user is optional. At least one of User and Groups must be specified. User string `json:"user" protobuf:"bytes,1,opt,name=user"` - // Groups is optional. Groups is the list of groups to which the User belongs. At least one of User and Groups must be specified. + // groups is optional. Groups is the list of groups to which the User belongs. At least one of User and Groups must be specified. Groups []string `json:"groups" protobuf:"bytes,2,rep,name=groups"` - // Scopes to use for the evaluation. Empty means "use the unscoped (full) permissions of the user/groups". + // scopes to use for the evaluation. Empty means "use the unscoped (full) permissions of the user/groups". Scopes OptionalScopes `json:"scopes" protobuf:"bytes,3,opt,name=scopes"` } // SubjectRulesReviewStatus is contains the result of a rules check type SubjectRulesReviewStatus struct { - // Rules is the list of rules (no particular sort) that are allowed for the subject + // rules is the list of rules (no particular sort) that are allowed for the subject Rules []PolicyRule `json:"rules" protobuf:"bytes,1,rep,name=rules"` - // EvaluationError can appear in combination with Rules. It means some error happened during evaluation + // evaluationError can appear in combination with Rules. It means some error happened during evaluation // that may have prevented additional rules from being populated. EvaluationError string `json:"evaluationError,omitempty" protobuf:"bytes,2,opt,name=evaluationError"` } @@ -223,7 +223,7 @@ type SubjectRulesReviewStatus struct { type ResourceAccessReviewResponse struct { metav1.TypeMeta `json:",inline"` - // Namespace is the namespace used for the access review + // namespace is the namespace used for the access review Namespace string `json:"namespace,omitempty" protobuf:"bytes,1,opt,name=namespace"` // UsersSlice is the list of users who can perform the action // +k8s:conversion-gen=false @@ -269,13 +269,13 @@ type ResourceAccessReview struct { type SubjectAccessReviewResponse struct { metav1.TypeMeta `json:",inline"` - // Namespace is the namespace used for the access review + // namespace is the namespace used for the access review Namespace string `json:"namespace,omitempty" protobuf:"bytes,1,opt,name=namespace"` - // Allowed is required. True if the action would be allowed, false otherwise. + // allowed is required. True if the action would be allowed, false otherwise. Allowed bool `json:"allowed" protobuf:"varint,2,opt,name=allowed"` - // Reason is optional. It indicates why a request was allowed or denied. + // reason is optional. It indicates why a request was allowed or denied. Reason string `json:"reason,omitempty" protobuf:"bytes,3,opt,name=reason"` - // EvaluationError is an indication that some error occurred during the authorization check. + // 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. EvaluationError string `json:"evaluationError,omitempty" protobuf:"bytes,4,opt,name=evaluationError"` @@ -309,12 +309,12 @@ type SubjectAccessReview struct { // Action describes the action being tested. Action `json:",inline" protobuf:"bytes,1,opt,name=Action"` - // User is optional. If both User and Groups are empty, the current authenticated user is used. + // user is optional. If both User and Groups are empty, the current authenticated user is used. User string `json:"user" protobuf:"bytes,2,opt,name=user"` // GroupsSlice is optional. Groups is the list of groups to which the User belongs. // +k8s:conversion-gen=false GroupsSlice []string `json:"groups" protobuf:"bytes,3,rep,name=groups"` - // Scopes to use for the evaluation. Empty means "use the unscoped (full) permissions of the user/groups". + // 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. // +k8s:conversion-gen=false @@ -359,12 +359,12 @@ type LocalSubjectAccessReview struct { // Action describes the action being tested. The Namespace element is FORCED to the current namespace. Action `json:",inline" protobuf:"bytes,1,opt,name=Action"` - // User is optional. If both User and Groups are empty, the current authenticated user is used. + // user is optional. If both User and Groups are empty, the current authenticated user is used. User string `json:"user" protobuf:"bytes,2,opt,name=user"` - // Groups is optional. Groups is the list of groups to which the User belongs. + // groups is optional. Groups is the list of groups to which the User belongs. // +k8s:conversion-gen=false GroupsSlice []string `json:"groups" protobuf:"bytes,3,rep,name=groups"` - // Scopes to use for the evaluation. Empty means "use the unscoped (full) permissions of the user/groups". + // 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. // +k8s:conversion-gen=false @@ -373,9 +373,9 @@ type LocalSubjectAccessReview struct { // Action describes a request to the API server type Action struct { - // Namespace is the namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces + // namespace is the namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces Namespace string `json:"namespace" protobuf:"bytes,1,opt,name=namespace"` - // Verb is one of: get, list, watch, create, update, delete + // verb is one of: get, list, watch, create, update, delete Verb string `json:"verb" protobuf:"bytes,2,opt,name=verb"` // Group is the API group of the resource // Serialized as resourceAPIGroup to avoid confusion with the 'groups' field when inlined @@ -383,15 +383,15 @@ type Action struct { // Version is the API version of the resource // Serialized as resourceAPIVersion to avoid confusion with TypeMeta.apiVersion and ObjectMeta.resourceVersion when inlined Version string `json:"resourceAPIVersion" protobuf:"bytes,4,opt,name=resourceAPIVersion"` - // Resource is one of the existing resource types + // resource is one of the existing resource types Resource string `json:"resource" protobuf:"bytes,5,opt,name=resource"` - // ResourceName is the name of the resource being requested for a "get" or deleted for a "delete" + // resourceName is the name of the resource being requested for a "get" or deleted for a "delete" ResourceName string `json:"resourceName" protobuf:"bytes,6,opt,name=resourceName"` - // Path is the path of a non resource URL + // path is the path of a non resource URL Path string `json:"path" protobuf:"bytes,8,opt,name=path"` - // IsNonResourceURL is true if this is a request for a non-resource URL (outside of the resource hierarchy) + // isNonResourceURL is true if this is a request for a non-resource URL (outside of the resource hierarchy) IsNonResourceURL bool `json:"isNonResourceURL" protobuf:"varint,9,opt,name=isNonResourceURL"` - // Content is the actual content of the request for create and update + // content is the actual content of the request for create and update // +kubebuilder:pruning:PreserveUnknownFields Content kruntime.RawExtension `json:"content,omitempty" protobuf:"bytes,7,opt,name=content"` } @@ -409,7 +409,7 @@ type RoleBindingList struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` - // Items is a list of RoleBindings + // items is a list of RoleBindings Items []RoleBinding `json:"items" protobuf:"bytes,2,rep,name=items"` } @@ -426,7 +426,7 @@ type RoleList struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` - // Items is a list of Roles + // items is a list of Roles Items []Role `json:"items" protobuf:"bytes,2,rep,name=items"` } @@ -445,10 +445,10 @@ type ClusterRole struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` - // Rules holds all the PolicyRules for this ClusterRole + // rules holds all the PolicyRules for this ClusterRole Rules []PolicyRule `json:"rules" protobuf:"bytes,2,rep,name=rules"` - // AggregationRule is an optional field that describes how to build the Rules for this ClusterRole. + // 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. AggregationRule *rbacv1.AggregationRule `json:"aggregationRule,omitempty" protobuf:"bytes,3,opt,name=aggregationRule"` @@ -471,26 +471,26 @@ type ClusterRoleBinding struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` - // UserNames holds all the usernames directly bound to the role. + // 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. // +k8s:conversion-gen=false // +optional UserNames OptionalNames `json:"userNames" protobuf:"bytes,2,rep,name=userNames"` - // GroupNames holds all the groups directly bound to the role. + // 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. // +k8s:conversion-gen=false // +optional GroupNames OptionalNames `json:"groupNames" protobuf:"bytes,3,rep,name=groupNames"` - // Subjects hold object references to authorize with this rule. + // 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. Subjects []corev1.ObjectReference `json:"subjects" protobuf:"bytes,4,rep,name=subjects"` - // RoleRef can only reference the current namespace and the global namespace. + // 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. RoleRef corev1.ObjectReference `json:"roleRef" protobuf:"bytes,5,opt,name=roleRef"` @@ -498,17 +498,17 @@ type ClusterRoleBinding struct { // NamedClusterRole relates a name with a cluster role type NamedClusterRole struct { - // Name is the name of the cluster role + // name is the name of the cluster role Name string `json:"name" protobuf:"bytes,1,opt,name=name"` - // Role is the cluster role being named + // role is the cluster role being named Role ClusterRole `json:"role" protobuf:"bytes,2,opt,name=role"` } // NamedClusterRoleBinding relates a name with a cluster role binding type NamedClusterRoleBinding struct { - // Name is the name of the cluster role binding + // name is the name of the cluster role binding Name string `json:"name" protobuf:"bytes,1,opt,name=name"` - // RoleBinding is the cluster role binding being named + // roleBinding is the cluster role binding being named RoleBinding ClusterRoleBinding `json:"roleBinding" protobuf:"bytes,2,opt,name=roleBinding"` } @@ -525,7 +525,7 @@ type ClusterRoleBindingList struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` - // Items is a list of ClusterRoleBindings + // items is a list of ClusterRoleBindings Items []ClusterRoleBinding `json:"items" protobuf:"bytes,2,rep,name=items"` } @@ -542,7 +542,7 @@ type ClusterRoleList struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` - // Items is a list of ClusterRoles + // items is a list of ClusterRoles Items []ClusterRole `json:"items" protobuf:"bytes,2,rep,name=items"` } @@ -569,22 +569,22 @@ type RoleBindingRestriction struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata" protobuf:"bytes,1,opt,name=metadata"` - // Spec defines the matcher. + // spec defines the matcher. Spec RoleBindingRestrictionSpec `json:"spec" protobuf:"bytes,2,opt,name=spec"` } // RoleBindingRestrictionSpec defines a rolebinding restriction. Exactly one // field must be non-nil. type RoleBindingRestrictionSpec struct { - // UserRestriction matches against user subjects. + // userrestriction matches against user subjects. // +nullable UserRestriction *UserRestriction `json:"userrestriction" protobuf:"bytes,1,opt,name=userrestriction"` - // GroupRestriction matches against group subjects. + // grouprestriction matches against group subjects. // +nullable GroupRestriction *GroupRestriction `json:"grouprestriction" protobuf:"bytes,2,opt,name=grouprestriction"` - // ServiceAccountRestriction matches against service-account subjects. + // serviceaccountrestriction matches against service-account subjects. // +nullable ServiceAccountRestriction *ServiceAccountRestriction `json:"serviceaccountrestriction" protobuf:"bytes,3,opt,name=serviceaccountrestriction"` } @@ -602,7 +602,7 @@ type RoleBindingRestrictionList struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` - // Items is a list of RoleBindingRestriction objects. + // items is a list of RoleBindingRestriction objects. Items []RoleBindingRestriction `json:"items" protobuf:"bytes,2,rep,name=items"` } @@ -610,10 +610,10 @@ type RoleBindingRestrictionList struct { // a string match on the name of a group to which the user belongs, or a label // selector applied to the user labels. type UserRestriction struct { - // Users specifies a list of literal user names. + // users specifies a list of literal user names. Users []string `json:"users" protobuf:"bytes,1,rep,name=users"` - // Groups specifies a list of literal group names. + // groups specifies a list of literal group names. // +nullable Groups []string `json:"groups" protobuf:"bytes,2,rep,name=groups"` @@ -625,7 +625,7 @@ type UserRestriction struct { // GroupRestriction matches a group either by a string match on the group name // or a label selector applied to group labels. type GroupRestriction struct { - // Groups is a list of groups used to match against an individual user's + // 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. // +nullable @@ -640,20 +640,20 @@ type GroupRestriction struct { // either the service-account name or the name of the service account's // namespace. type ServiceAccountRestriction struct { - // ServiceAccounts specifies a list of literal service-account names. + // serviceaccounts specifies a list of literal service-account names. ServiceAccounts []ServiceAccountReference `json:"serviceaccounts" protobuf:"bytes,1,rep,name=serviceaccounts"` - // Namespaces specifies a list of literal namespace names. + // namespaces specifies a list of literal namespace names. Namespaces []string `json:"namespaces" protobuf:"bytes,2,rep,name=namespaces"` } // ServiceAccountReference specifies a service account and namespace by their // names. type ServiceAccountReference struct { - // Name is the name of the service account. + // name is the name of the service account. Name string `json:"name" protobuf:"bytes,1,opt,name=name"` - // Namespace is the namespace of the service account. Service accounts from + // 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. diff --git a/authorization/v1/zz_generated.crd-manifests/0000_03_config-operator_01_rolebindingrestrictions.crd.yaml b/authorization/v1/zz_generated.crd-manifests/0000_03_config-operator_01_rolebindingrestrictions.crd.yaml index c5c8dc8fdce..275e90aeec0 100644 --- a/authorization/v1/zz_generated.crd-manifests/0000_03_config-operator_01_rolebindingrestrictions.crd.yaml +++ b/authorization/v1/zz_generated.crd-manifests/0000_03_config-operator_01_rolebindingrestrictions.crd.yaml @@ -47,15 +47,15 @@ spec: metadata: type: object spec: - description: Spec defines the matcher. + description: spec defines the matcher. properties: grouprestriction: - description: GroupRestriction matches against group subjects. + description: grouprestriction matches against group subjects. nullable: true properties: groups: description: |- - Groups is a list of groups used to match against an individual user's + 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. items: @@ -118,18 +118,18 @@ spec: type: array type: object serviceaccountrestriction: - description: ServiceAccountRestriction matches against service-account + description: serviceaccountrestriction matches against service-account subjects. nullable: true properties: namespaces: - description: Namespaces specifies a list of literal namespace + description: namespaces specifies a list of literal namespace names. items: type: string type: array serviceaccounts: - description: ServiceAccounts specifies a list of literal service-account + description: serviceaccounts specifies a list of literal service-account names. items: description: |- @@ -137,11 +137,11 @@ spec: names. properties: name: - description: Name is the name of the service account. + description: name is the name of the service account. type: string namespace: description: |- - Namespace is the namespace of the service account. Service accounts from + 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. @@ -150,11 +150,11 @@ spec: type: array type: object userrestriction: - description: UserRestriction matches against user subjects. + description: userrestriction matches against user subjects. nullable: true properties: groups: - description: Groups specifies a list of literal group names. + description: groups specifies a list of literal group names. items: type: string nullable: true @@ -214,7 +214,7 @@ spec: nullable: true type: array users: - description: Users specifies a list of literal user names. + description: users specifies a list of literal user names. items: type: string type: array diff --git a/authorization/v1/zz_generated.featuregated-crd-manifests/rolebindingrestrictions.authorization.openshift.io/AAA_ungated.yaml b/authorization/v1/zz_generated.featuregated-crd-manifests/rolebindingrestrictions.authorization.openshift.io/AAA_ungated.yaml index 0990d50d6a2..db718a56a22 100644 --- a/authorization/v1/zz_generated.featuregated-crd-manifests/rolebindingrestrictions.authorization.openshift.io/AAA_ungated.yaml +++ b/authorization/v1/zz_generated.featuregated-crd-manifests/rolebindingrestrictions.authorization.openshift.io/AAA_ungated.yaml @@ -48,15 +48,15 @@ spec: metadata: type: object spec: - description: Spec defines the matcher. + description: spec defines the matcher. properties: grouprestriction: - description: GroupRestriction matches against group subjects. + description: grouprestriction matches against group subjects. nullable: true properties: groups: description: |- - Groups is a list of groups used to match against an individual user's + 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. items: @@ -119,18 +119,18 @@ spec: type: array type: object serviceaccountrestriction: - description: ServiceAccountRestriction matches against service-account + description: serviceaccountrestriction matches against service-account subjects. nullable: true properties: namespaces: - description: Namespaces specifies a list of literal namespace + description: namespaces specifies a list of literal namespace names. items: type: string type: array serviceaccounts: - description: ServiceAccounts specifies a list of literal service-account + description: serviceaccounts specifies a list of literal service-account names. items: description: |- @@ -138,11 +138,11 @@ spec: names. properties: name: - description: Name is the name of the service account. + description: name is the name of the service account. type: string namespace: description: |- - Namespace is the namespace of the service account. Service accounts from + 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. @@ -151,11 +151,11 @@ spec: type: array type: object userrestriction: - description: UserRestriction matches against user subjects. + description: userrestriction matches against user subjects. nullable: true properties: groups: - description: Groups specifies a list of literal group names. + description: groups specifies a list of literal group names. items: type: string nullable: true @@ -215,7 +215,7 @@ spec: nullable: true type: array users: - description: Users specifies a list of literal user names. + description: users specifies a list of literal user names. items: type: string type: array diff --git a/authorization/v1/zz_generated.swagger_doc_generated.go b/authorization/v1/zz_generated.swagger_doc_generated.go index a8f9b374e2b..a1c28a3ec12 100644 --- a/authorization/v1/zz_generated.swagger_doc_generated.go +++ b/authorization/v1/zz_generated.swagger_doc_generated.go @@ -13,15 +13,15 @@ package v1 // AUTO-GENERATED FUNCTIONS START HERE var map_Action = map[string]string{ "": "Action describes a request to the API server", - "namespace": "Namespace is the namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces", - "verb": "Verb is one of: get, list, watch, create, update, delete", + "namespace": "namespace is the namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces", + "verb": "verb is one of: get, list, watch, create, update, delete", "resourceAPIGroup": "Group is the API group of the resource Serialized as resourceAPIGroup to avoid confusion with the 'groups' field when inlined", "resourceAPIVersion": "Version is the API version of the resource Serialized as resourceAPIVersion to avoid confusion with TypeMeta.apiVersion and ObjectMeta.resourceVersion when inlined", - "resource": "Resource is one of the existing resource types", - "resourceName": "ResourceName is the name of the resource being requested for a \"get\" or deleted for a \"delete\"", - "path": "Path is the path of a non resource URL", - "isNonResourceURL": "IsNonResourceURL is true if this is a request for a non-resource URL (outside of the resource hierarchy)", - "content": "Content is the actual content of the request for create and update", + "resource": "resource is one of the existing resource types", + "resourceName": "resourceName is the name of the resource being requested for a \"get\" or deleted for a \"delete\"", + "path": "path is the path of a non resource URL", + "isNonResourceURL": "isNonResourceURL is true if this is a request for a non-resource URL (outside of the resource hierarchy)", + "content": "content is the actual content of the request for create and update", } func (Action) SwaggerDoc() map[string]string { @@ -31,8 +31,8 @@ func (Action) SwaggerDoc() map[string]string { var map_ClusterRole = map[string]string{ "": "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).", "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "rules": "Rules holds all the PolicyRules for this ClusterRole", - "aggregationRule": "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.", + "rules": "rules holds all the PolicyRules for this ClusterRole", + "aggregationRule": "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.", } func (ClusterRole) SwaggerDoc() map[string]string { @@ -42,10 +42,10 @@ func (ClusterRole) SwaggerDoc() map[string]string { var map_ClusterRoleBinding = map[string]string{ "": "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).", "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "userNames": "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.", - "groupNames": "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.", - "subjects": "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.", - "roleRef": "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.", + "userNames": "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.", + "groupNames": "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.", + "subjects": "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.", + "roleRef": "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.", } func (ClusterRoleBinding) SwaggerDoc() map[string]string { @@ -55,7 +55,7 @@ func (ClusterRoleBinding) SwaggerDoc() map[string]string { var map_ClusterRoleBindingList = map[string]string{ "": "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).", "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "items": "Items is a list of ClusterRoleBindings", + "items": "items is a list of ClusterRoleBindings", } func (ClusterRoleBindingList) SwaggerDoc() map[string]string { @@ -65,7 +65,7 @@ func (ClusterRoleBindingList) SwaggerDoc() map[string]string { var map_ClusterRoleList = map[string]string{ "": "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).", "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "items": "Items is a list of ClusterRoles", + "items": "items is a list of ClusterRoles", } func (ClusterRoleList) SwaggerDoc() map[string]string { @@ -74,7 +74,7 @@ func (ClusterRoleList) SwaggerDoc() map[string]string { var map_GroupRestriction = map[string]string{ "": "GroupRestriction matches a group either by a string match on the group name or a label selector applied to group labels.", - "groups": "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.", + "groups": "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.", "labels": "Selectors specifies a list of label selectors over group labels.", } @@ -102,9 +102,9 @@ func (LocalResourceAccessReview) SwaggerDoc() map[string]string { var map_LocalSubjectAccessReview = map[string]string{ "": "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).", "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "user": "User is optional. If both User and Groups are empty, the current authenticated user is used.", - "groups": "Groups is optional. Groups is the list of groups to which the User belongs.", - "scopes": "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.", + "user": "user is optional. If both User and Groups are empty, the current authenticated user is used.", + "groups": "groups is optional. Groups is the list of groups to which the User belongs.", + "scopes": "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.", } func (LocalSubjectAccessReview) SwaggerDoc() map[string]string { @@ -113,8 +113,8 @@ func (LocalSubjectAccessReview) SwaggerDoc() map[string]string { var map_NamedClusterRole = map[string]string{ "": "NamedClusterRole relates a name with a cluster role", - "name": "Name is the name of the cluster role", - "role": "Role is the cluster role being named", + "name": "name is the name of the cluster role", + "role": "role is the cluster role being named", } func (NamedClusterRole) SwaggerDoc() map[string]string { @@ -123,8 +123,8 @@ func (NamedClusterRole) SwaggerDoc() map[string]string { var map_NamedClusterRoleBinding = map[string]string{ "": "NamedClusterRoleBinding relates a name with a cluster role binding", - "name": "Name is the name of the cluster role binding", - "roleBinding": "RoleBinding is the cluster role binding being named", + "name": "name is the name of the cluster role binding", + "roleBinding": "roleBinding is the cluster role binding being named", } func (NamedClusterRoleBinding) SwaggerDoc() map[string]string { @@ -133,8 +133,8 @@ func (NamedClusterRoleBinding) SwaggerDoc() map[string]string { var map_NamedRole = map[string]string{ "": "NamedRole relates a Role with a name", - "name": "Name is the name of the role", - "role": "Role is the role being named", + "name": "name is the name of the role", + "role": "role is the role being named", } func (NamedRole) SwaggerDoc() map[string]string { @@ -143,8 +143,8 @@ func (NamedRole) SwaggerDoc() map[string]string { var map_NamedRoleBinding = map[string]string{ "": "NamedRoleBinding relates a role binding with a name", - "name": "Name is the name of the role binding", - "roleBinding": "RoleBinding is the role binding being named", + "name": "name is the name of the role binding", + "roleBinding": "roleBinding is the role binding being named", } func (NamedRoleBinding) SwaggerDoc() map[string]string { @@ -153,11 +153,11 @@ func (NamedRoleBinding) SwaggerDoc() map[string]string { var map_PolicyRule = map[string]string{ "": "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.", - "verbs": "Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. VerbAll represents all kinds.", - "attributeRestrictions": "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.", - "apiGroups": "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", - "resources": "Resources is a list of resources this rule applies to. ResourceAll represents all resources.", - "resourceNames": "ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.", + "verbs": "verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. VerbAll represents all kinds.", + "attributeRestrictions": "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.", + "apiGroups": "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", + "resources": "resources is a list of resources this rule applies to. ResourceAll represents all resources.", + "resourceNames": "resourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.", "nonResourceURLs": "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.", } @@ -176,7 +176,7 @@ func (ResourceAccessReview) SwaggerDoc() map[string]string { var map_ResourceAccessReviewResponse = map[string]string{ "": "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).", - "namespace": "Namespace is the namespace used for the access review", + "namespace": "namespace is the namespace used for the access review", "users": "UsersSlice is the list of users who can perform the action", "groups": "GroupsSlice is the list of groups who can perform the action", "evalutionError": "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.", @@ -189,7 +189,7 @@ func (ResourceAccessReviewResponse) SwaggerDoc() map[string]string { var map_Role = map[string]string{ "": "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).", "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "rules": "Rules holds all the PolicyRules for this Role", + "rules": "rules holds all the PolicyRules for this Role", } func (Role) SwaggerDoc() map[string]string { @@ -199,10 +199,10 @@ func (Role) SwaggerDoc() map[string]string { var map_RoleBinding = map[string]string{ "": "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).", "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "userNames": "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.", - "groupNames": "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.", - "subjects": "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.", - "roleRef": "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.", + "userNames": "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.", + "groupNames": "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.", + "subjects": "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.", + "roleRef": "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.", } func (RoleBinding) SwaggerDoc() map[string]string { @@ -212,7 +212,7 @@ func (RoleBinding) SwaggerDoc() map[string]string { var map_RoleBindingList = map[string]string{ "": "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).", "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "items": "Items is a list of RoleBindings", + "items": "items is a list of RoleBindings", } func (RoleBindingList) SwaggerDoc() map[string]string { @@ -222,7 +222,7 @@ func (RoleBindingList) SwaggerDoc() map[string]string { var map_RoleBindingRestriction = map[string]string{ "": "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).", "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "spec": "Spec defines the matcher.", + "spec": "spec defines the matcher.", } func (RoleBindingRestriction) SwaggerDoc() map[string]string { @@ -232,7 +232,7 @@ func (RoleBindingRestriction) SwaggerDoc() map[string]string { var map_RoleBindingRestrictionList = map[string]string{ "": "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).", "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "items": "Items is a list of RoleBindingRestriction objects.", + "items": "items is a list of RoleBindingRestriction objects.", } func (RoleBindingRestrictionList) SwaggerDoc() map[string]string { @@ -241,9 +241,9 @@ func (RoleBindingRestrictionList) SwaggerDoc() map[string]string { var map_RoleBindingRestrictionSpec = map[string]string{ "": "RoleBindingRestrictionSpec defines a rolebinding restriction. Exactly one field must be non-nil.", - "userrestriction": "UserRestriction matches against user subjects.", - "grouprestriction": "GroupRestriction matches against group subjects.", - "serviceaccountrestriction": "ServiceAccountRestriction matches against service-account subjects.", + "userrestriction": "userrestriction matches against user subjects.", + "grouprestriction": "grouprestriction matches against group subjects.", + "serviceaccountrestriction": "serviceaccountrestriction matches against service-account subjects.", } func (RoleBindingRestrictionSpec) SwaggerDoc() map[string]string { @@ -253,7 +253,7 @@ func (RoleBindingRestrictionSpec) SwaggerDoc() map[string]string { var map_RoleList = map[string]string{ "": "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).", "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "items": "Items is a list of Roles", + "items": "items is a list of Roles", } func (RoleList) SwaggerDoc() map[string]string { @@ -263,8 +263,8 @@ func (RoleList) SwaggerDoc() map[string]string { var map_SelfSubjectRulesReview = map[string]string{ "": "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).", "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "spec": "Spec adds information about how to conduct the check", - "status": "Status is completed by the server to tell which permissions you have", + "spec": "spec adds information about how to conduct the check", + "status": "status is completed by the server to tell which permissions you have", } func (SelfSubjectRulesReview) SwaggerDoc() map[string]string { @@ -273,7 +273,7 @@ func (SelfSubjectRulesReview) SwaggerDoc() map[string]string { var map_SelfSubjectRulesReviewSpec = map[string]string{ "": "SelfSubjectRulesReviewSpec adds information about how to conduct the check", - "scopes": "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\".", + "scopes": "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\".", } func (SelfSubjectRulesReviewSpec) SwaggerDoc() map[string]string { @@ -282,8 +282,8 @@ func (SelfSubjectRulesReviewSpec) SwaggerDoc() map[string]string { var map_ServiceAccountReference = map[string]string{ "": "ServiceAccountReference specifies a service account and namespace by their names.", - "name": "Name is the name of the service account.", - "namespace": "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.", + "name": "name is the name of the service account.", + "namespace": "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.", } func (ServiceAccountReference) SwaggerDoc() map[string]string { @@ -292,8 +292,8 @@ func (ServiceAccountReference) SwaggerDoc() map[string]string { var map_ServiceAccountRestriction = map[string]string{ "": "ServiceAccountRestriction matches a service account by a string match on either the service-account name or the name of the service account's namespace.", - "serviceaccounts": "ServiceAccounts specifies a list of literal service-account names.", - "namespaces": "Namespaces specifies a list of literal namespace names.", + "serviceaccounts": "serviceaccounts specifies a list of literal service-account names.", + "namespaces": "namespaces specifies a list of literal namespace names.", } func (ServiceAccountRestriction) SwaggerDoc() map[string]string { @@ -303,9 +303,9 @@ func (ServiceAccountRestriction) SwaggerDoc() map[string]string { var map_SubjectAccessReview = map[string]string{ "": "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).", "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "user": "User is optional. If both User and Groups are empty, the current authenticated user is used.", + "user": "user is optional. If both User and Groups are empty, the current authenticated user is used.", "groups": "GroupsSlice is optional. Groups is the list of groups to which the User belongs.", - "scopes": "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.", + "scopes": "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.", } func (SubjectAccessReview) SwaggerDoc() map[string]string { @@ -314,10 +314,10 @@ func (SubjectAccessReview) SwaggerDoc() map[string]string { var map_SubjectAccessReviewResponse = map[string]string{ "": "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).", - "namespace": "Namespace is the namespace used for the access review", - "allowed": "Allowed is required. True if the action would be allowed, false otherwise.", - "reason": "Reason is optional. It indicates why a request was allowed or denied.", - "evaluationError": "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.", + "namespace": "namespace is the namespace used for the access review", + "allowed": "allowed is required. True if the action would be allowed, false otherwise.", + "reason": "reason is optional. It indicates why a request was allowed or denied.", + "evaluationError": "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.", } func (SubjectAccessReviewResponse) SwaggerDoc() map[string]string { @@ -327,8 +327,8 @@ func (SubjectAccessReviewResponse) SwaggerDoc() map[string]string { var map_SubjectRulesReview = map[string]string{ "": "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).", "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "spec": "Spec adds information about how to conduct the check", - "status": "Status is completed by the server to tell which permissions you have", + "spec": "spec adds information about how to conduct the check", + "status": "status is completed by the server to tell which permissions you have", } func (SubjectRulesReview) SwaggerDoc() map[string]string { @@ -337,9 +337,9 @@ func (SubjectRulesReview) SwaggerDoc() map[string]string { var map_SubjectRulesReviewSpec = map[string]string{ "": "SubjectRulesReviewSpec adds information about how to conduct the check", - "user": "User is optional. At least one of User and Groups must be specified.", - "groups": "Groups is optional. Groups is the list of groups to which the User belongs. At least one of User and Groups must be specified.", - "scopes": "Scopes to use for the evaluation. Empty means \"use the unscoped (full) permissions of the user/groups\".", + "user": "user is optional. At least one of User and Groups must be specified.", + "groups": "groups is optional. Groups is the list of groups to which the User belongs. At least one of User and Groups must be specified.", + "scopes": "scopes to use for the evaluation. Empty means \"use the unscoped (full) permissions of the user/groups\".", } func (SubjectRulesReviewSpec) SwaggerDoc() map[string]string { @@ -348,8 +348,8 @@ func (SubjectRulesReviewSpec) SwaggerDoc() map[string]string { var map_SubjectRulesReviewStatus = map[string]string{ "": "SubjectRulesReviewStatus is contains the result of a rules check", - "rules": "Rules is the list of rules (no particular sort) that are allowed for the subject", - "evaluationError": "EvaluationError can appear in combination with Rules. It means some error happened during evaluation that may have prevented additional rules from being populated.", + "rules": "rules is the list of rules (no particular sort) that are allowed for the subject", + "evaluationError": "evaluationError can appear in combination with Rules. It means some error happened during evaluation that may have prevented additional rules from being populated.", } func (SubjectRulesReviewStatus) SwaggerDoc() map[string]string { @@ -358,8 +358,8 @@ func (SubjectRulesReviewStatus) SwaggerDoc() map[string]string { var map_UserRestriction = map[string]string{ "": "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.", - "users": "Users specifies a list of literal user names.", - "groups": "Groups specifies a list of literal group names.", + "users": "users specifies a list of literal user names.", + "groups": "groups specifies a list of literal group names.", "labels": "Selectors specifies a list of label selectors over user labels.", } diff --git a/build/v1/generated.proto b/build/v1/generated.proto index b71670f4ecb..92ae73426c8 100644 --- a/build/v1/generated.proto +++ b/build/v1/generated.proto @@ -81,10 +81,10 @@ message Build { // BuildCondition describes the state of a build at a certain point. message BuildCondition { - // Type of build condition. + // type of build condition. optional string type = 1; - // Status of the condition, one of True, False, Unknown. + // status of the condition, one of True, False, Unknown. optional string status = 2; // The last time this condition was updated. @@ -141,7 +141,7 @@ message BuildConfigSpec { // +optional repeated BuildTriggerPolicy triggers = 1; - // RunPolicy describes how the new build created from this build + // 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". optional string runPolicy = 2; @@ -165,7 +165,7 @@ message BuildConfigStatus { // lastVersion is used to inform about number of last triggered build. optional int64 lastVersion = 1; - // ImageChangeTriggers captures the runtime state of any ImageChangeTrigger specified in the BuildConfigSpec, + // 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. repeated ImageChangeTriggerStatus imageChangeTriggers = 2; @@ -231,7 +231,7 @@ message BuildLogOptions { // slightly more or slightly less than the specified limit. optional int64 limitBytes = 8; - // noWait if true causes the call to return immediately even if the build + // 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. // TODO: Fix the tag to 'noWait' in v2 optional bool nowait = 9; @@ -259,7 +259,7 @@ message BuildOutput { // the build unless Namespace is specified. optional .k8s.io.api.core.v1.ObjectReference to = 1; - // PushSecret is the name of a Secret that would be used for setting + // 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). optional .k8s.io.api.core.v1.LocalObjectReference pushSecret = 2; @@ -392,10 +392,10 @@ message BuildRequest { // build configuration and contains information about those triggers. repeated BuildTriggerCause triggeredBy = 8; - // DockerStrategyOptions contains additional docker-strategy specific options for the build + // dockerStrategyOptions contains additional docker-strategy specific options for the build optional DockerStrategyOptions dockerStrategyOptions = 9; - // SourceStrategyOptions contains additional source-strategy specific options for the build + // sourceStrategyOptions contains additional source-strategy specific options for the build optional SourceStrategyOptions sourceStrategyOptions = 10; } @@ -510,7 +510,7 @@ message BuildStatus { // logSnippet is the last few lines of the build log. This value is only set for builds that failed. optional string logSnippet = 12; - // Conditions represents the latest available observations of a build's current state. + // conditions represents the latest available observations of a build's current state. // +patchMergeKey=type // +patchStrategy=merge repeated BuildCondition conditions = 13; @@ -550,7 +550,7 @@ message BuildStrategy { // customStrategy holds the parameters to the Custom build strategy optional CustomBuildStrategy customStrategy = 4; - // JenkinsPipelineStrategy holds the parameters to the Jenkins Pipeline build strategy. + // jenkinsPipelineStrategy holds the parameters to the Jenkins Pipeline build strategy. // Deprecated: use OpenShift Pipelines optional JenkinsPipelineBuildStrategy jenkinsPipelineStrategy = 5; } @@ -567,7 +567,7 @@ message BuildTriggerCause { // genericWebHook holds data about a builds generic webhook trigger. optional GenericWebHookCause genericWebHook = 2; - // gitHubWebHook represents data for a GitHub webhook that fired a + // githubWebHook represents data for a GitHub webhook that fired a // specific build. optional GitHubWebHookCause githubWebHook = 3; @@ -575,11 +575,11 @@ message BuildTriggerCause { // that triggered a new build. optional ImageChangeCause imageChangeBuild = 4; - // GitLabWebHook represents data for a GitLab webhook that fired a specific + // gitlabWebHook represents data for a GitLab webhook that fired a specific // build. optional GitLabWebHookCause gitlabWebHook = 5; - // BitbucketWebHook represents data for a Bitbucket webhook that fired a + // bitbucketWebHook represents data for a Bitbucket webhook that fired a // specific build. optional BitbucketWebHookCause bitbucketWebHook = 6; } @@ -743,10 +743,10 @@ message CommonSpec { // 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. message CommonWebHookCause { - // Revision is the git source revision information of the trigger. + // revision is the git source revision information of the trigger. optional SourceRevision revision = 1; - // Secret is the obfuscated webhook secret that triggered a build. + // secret is the obfuscated webhook secret that triggered a build. optional string secret = 2; } @@ -884,7 +884,7 @@ message GenericWebHookEvent { // ValueFrom is not supported. repeated .k8s.io.api.core.v1.EnvVar env = 3; - // DockerStrategyOptions contains additional docker-strategy specific options for the build + // dockerStrategyOptions contains additional docker-strategy specific options for the build optional DockerStrategyOptions dockerStrategyOptions = 4; } @@ -918,7 +918,7 @@ message GitInfo { optional GitSourceRevision gitSourceRevision = 2; - // Refs is a list of GitRefs for the provided repo - generally sent + // 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 repeated GitRefInfo refs = 3; @@ -1061,12 +1061,12 @@ message ImageStreamTagReference { // JenkinsPipelineBuildStrategy holds parameters specific to a Jenkins Pipeline build. // Deprecated: use OpenShift Pipelines message JenkinsPipelineBuildStrategy { - // JenkinsfilePath is the optional path of the Jenkinsfile that will be used to configure the pipeline + // 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. optional string jenkinsfilePath = 1; - // Jenkinsfile defines the optional raw contents of a Jenkinsfile which defines a Jenkins pipeline build. + // jenkinsfile defines the optional raw contents of a Jenkinsfile which defines a Jenkins pipeline build. optional string jenkinsfile = 2; // env contains additional environment variables you want to pass into a build pipeline. @@ -1115,7 +1115,7 @@ message SecretBuildSource { // SecretLocalReference contains information that points to the local secret being used message SecretLocalReference { - // Name is the name of the resource in the same namespace being referenced + // name is the name of the resource in the same namespace being referenced optional string name = 1; } @@ -1176,7 +1176,7 @@ message SourceRevision { // +k8s:conversion-gen=false optional string type = 1; - // Git contains information about git-based build source + // git contains information about git-based build source optional GitSourceRevision git = 2; } diff --git a/build/v1/types.go b/build/v1/types.go index ba836aad810..12bf67db1a2 100644 --- a/build/v1/types.go +++ b/build/v1/types.go @@ -116,7 +116,7 @@ type BuildTriggerCause struct { // genericWebHook holds data about a builds generic webhook trigger. GenericWebHook *GenericWebHookCause `json:"genericWebHook,omitempty" protobuf:"bytes,2,opt,name=genericWebHook"` - // gitHubWebHook represents data for a GitHub webhook that fired a + // githubWebHook represents data for a GitHub webhook that fired a //specific build. GitHubWebHook *GitHubWebHookCause `json:"githubWebHook,omitempty" protobuf:"bytes,3,opt,name=githubWebHook"` @@ -124,11 +124,11 @@ type BuildTriggerCause struct { // that triggered a new build. ImageChangeBuild *ImageChangeCause `json:"imageChangeBuild,omitempty" protobuf:"bytes,4,opt,name=imageChangeBuild"` - // GitLabWebHook represents data for a GitLab webhook that fired a specific + // gitlabWebHook represents data for a GitLab webhook that fired a specific // build. GitLabWebHook *GitLabWebHookCause `json:"gitlabWebHook,omitempty" protobuf:"bytes,5,opt,name=gitlabWebHook"` - // BitbucketWebHook represents data for a Bitbucket webhook that fired a + // bitbucketWebHook represents data for a Bitbucket webhook that fired a // specific build. BitbucketWebHook *BitbucketWebHookCause `json:"bitbucketWebHook,omitempty" protobuf:"bytes,6,opt,name=bitbucketWebHook"` } @@ -158,10 +158,10 @@ type GitHubWebHookCause struct { // 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 CommonWebHookCause struct { - // Revision is the git source revision information of the trigger. + // revision is the git source revision information of the trigger. Revision *SourceRevision `json:"revision,omitempty" protobuf:"bytes,1,opt,name=revision"` - // Secret is the obfuscated webhook secret that triggered a build. + // secret is the obfuscated webhook secret that triggered a build. Secret string `json:"secret,omitempty" protobuf:"bytes,2,opt,name=secret"` } @@ -237,7 +237,7 @@ type BuildStatus struct { // logSnippet is the last few lines of the build log. This value is only set for builds that failed. LogSnippet string `json:"logSnippet,omitempty" protobuf:"bytes,12,opt,name=logSnippet"` - // Conditions represents the latest available observations of a build's current state. + // conditions represents the latest available observations of a build's current state. // +patchMergeKey=type // +patchStrategy=merge Conditions []BuildCondition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,13,rep,name=conditions"` @@ -358,9 +358,9 @@ type BuildConditionType string // BuildCondition describes the state of a build at a certain point. type BuildCondition struct { - // Type of build condition. + // type of build condition. Type BuildConditionType `json:"type" protobuf:"bytes,1,opt,name=type,casttype=BuildConditionType"` - // Status of the condition, one of True, False, Unknown. + // status of the condition, one of True, False, Unknown. Status corev1.ConditionStatus `json:"status" protobuf:"bytes,2,opt,name=status,casttype=k8s.io/kubernetes/pkg/api/v1.ConditionStatus"` // The last time this condition was updated. LastUpdateTime metav1.Time `json:"lastUpdateTime,omitempty" protobuf:"bytes,6,opt,name=lastUpdateTime"` @@ -562,7 +562,7 @@ type SourceRevision struct { // +k8s:conversion-gen=false Type BuildSourceType `json:"type" protobuf:"bytes,1,opt,name=type,casttype=BuildSourceType"` - // Git contains information about git-based build source + // git contains information about git-based build source Git *GitSourceRevision `json:"git,omitempty" protobuf:"bytes,2,opt,name=git"` } @@ -632,7 +632,7 @@ type BuildStrategy struct { // customStrategy holds the parameters to the Custom build strategy CustomStrategy *CustomBuildStrategy `json:"customStrategy,omitempty" protobuf:"bytes,4,opt,name=customStrategy"` - // JenkinsPipelineStrategy holds the parameters to the Jenkins Pipeline build strategy. + // jenkinsPipelineStrategy holds the parameters to the Jenkins Pipeline build strategy. // Deprecated: use OpenShift Pipelines JenkinsPipelineStrategy *JenkinsPipelineBuildStrategy `json:"jenkinsPipelineStrategy,omitempty" protobuf:"bytes,5,opt,name=jenkinsPipelineStrategy"` } @@ -801,12 +801,12 @@ type SourceBuildStrategy struct { // JenkinsPipelineBuildStrategy holds parameters specific to a Jenkins Pipeline build. // Deprecated: use OpenShift Pipelines type JenkinsPipelineBuildStrategy struct { - // JenkinsfilePath is the optional path of the Jenkinsfile that will be used to configure the pipeline + // 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. JenkinsfilePath string `json:"jenkinsfilePath,omitempty" protobuf:"bytes,1,opt,name=jenkinsfilePath"` - // Jenkinsfile defines the optional raw contents of a Jenkinsfile which defines a Jenkins pipeline build. + // jenkinsfile defines the optional raw contents of a Jenkinsfile which defines a Jenkins pipeline build. Jenkinsfile string `json:"jenkinsfile,omitempty" protobuf:"bytes,2,opt,name=jenkinsfile"` // env contains additional environment variables you want to pass into a build pipeline. @@ -911,7 +911,7 @@ type BuildOutput struct { // the build unless Namespace is specified. To *corev1.ObjectReference `json:"to,omitempty" protobuf:"bytes,1,opt,name=to"` - // PushSecret is the name of a Secret that would be used for setting + // 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). PushSecret *corev1.LocalObjectReference `json:"pushSecret,omitempty" protobuf:"bytes,2,opt,name=pushSecret"` @@ -964,7 +964,7 @@ type BuildConfigSpec struct { // +optional Triggers []BuildTriggerPolicy `json:"triggers,omitempty" protobuf:"bytes,1,rep,name=triggers"` - // RunPolicy describes how the new build created from this build + // 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". RunPolicy BuildRunPolicy `json:"runPolicy,omitempty" protobuf:"bytes,2,opt,name=runPolicy,casttype=BuildRunPolicy"` @@ -1007,7 +1007,7 @@ type BuildConfigStatus struct { // lastVersion is used to inform about number of last triggered build. LastVersion int64 `json:"lastVersion" protobuf:"varint,1,opt,name=lastVersion"` - // ImageChangeTriggers captures the runtime state of any ImageChangeTrigger specified in the BuildConfigSpec, + // 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. ImageChangeTriggers []ImageChangeTriggerStatus `json:"imageChangeTriggers,omitempty" protobuf:"bytes,2,rep,name=imageChangeTriggers"` @@ -1015,7 +1015,7 @@ type BuildConfigStatus struct { // SecretLocalReference contains information that points to the local secret being used type SecretLocalReference struct { - // Name is the name of the resource in the same namespace being referenced + // name is the name of the resource in the same namespace being referenced Name string `json:"name" protobuf:"bytes,1,opt,name=name"` } @@ -1203,7 +1203,7 @@ type GenericWebHookEvent struct { // ValueFrom is not supported. Env []corev1.EnvVar `json:"env,omitempty" protobuf:"bytes,3,rep,name=env"` - // DockerStrategyOptions contains additional docker-strategy specific options for the build + // dockerStrategyOptions contains additional docker-strategy specific options for the build DockerStrategyOptions *DockerStrategyOptions `json:"dockerStrategyOptions,omitempty" protobuf:"bytes,4,opt,name=dockerStrategyOptions"` } @@ -1212,7 +1212,7 @@ type GitInfo struct { GitBuildSource `json:",inline" protobuf:"bytes,1,opt,name=gitBuildSource"` GitSourceRevision `json:",inline" protobuf:"bytes,2,opt,name=gitSourceRevision"` - // Refs is a list of GitRefs for the provided repo - generally sent + // 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 Refs []GitRefInfo `json:"refs" protobuf:"bytes,3,rep,name=refs"` @@ -1287,10 +1287,10 @@ type BuildRequest struct { // build configuration and contains information about those triggers. TriggeredBy []BuildTriggerCause `json:"triggeredBy,omitempty" protobuf:"bytes,8,rep,name=triggeredBy"` - // DockerStrategyOptions contains additional docker-strategy specific options for the build + // dockerStrategyOptions contains additional docker-strategy specific options for the build DockerStrategyOptions *DockerStrategyOptions `json:"dockerStrategyOptions,omitempty" protobuf:"bytes,9,opt,name=dockerStrategyOptions"` - // SourceStrategyOptions contains additional source-strategy specific options for the build + // sourceStrategyOptions contains additional source-strategy specific options for the build SourceStrategyOptions *SourceStrategyOptions `json:"sourceStrategyOptions,omitempty" protobuf:"bytes,10,opt,name=sourceStrategyOptions"` } @@ -1368,7 +1368,7 @@ type BuildLogOptions struct { // slightly more or slightly less than the specified limit. LimitBytes *int64 `json:"limitBytes,omitempty" protobuf:"varint,8,opt,name=limitBytes"` - // noWait if true causes the call to return immediately even if the build + // 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. // TODO: Fix the tag to 'noWait' in v2 NoWait bool `json:"nowait,omitempty" protobuf:"varint,9,opt,name=nowait"` diff --git a/build/v1/zz_generated.swagger_doc_generated.go b/build/v1/zz_generated.swagger_doc_generated.go index 72ff507b7dd..1da7843537f 100644 --- a/build/v1/zz_generated.swagger_doc_generated.go +++ b/build/v1/zz_generated.swagger_doc_generated.go @@ -57,8 +57,8 @@ func (Build) SwaggerDoc() map[string]string { var map_BuildCondition = map[string]string{ "": "BuildCondition describes the state of a build at a certain point.", - "type": "Type of build condition.", - "status": "Status of the condition, one of True, False, Unknown.", + "type": "type of build condition.", + "status": "status of the condition, one of True, False, Unknown.", "lastUpdateTime": "The last time this condition was updated.", "lastTransitionTime": "The last time the condition transitioned from one status to another.", "reason": "The reason for the condition's last transition.", @@ -93,7 +93,7 @@ func (BuildConfigList) SwaggerDoc() map[string]string { var map_BuildConfigSpec = map[string]string{ "": "BuildConfigSpec describes when and how builds are created", "triggers": "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.", - "runPolicy": "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\".", + "runPolicy": "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\".", "successfulBuildsHistoryLimit": "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.", "failedBuildsHistoryLimit": "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.", } @@ -105,7 +105,7 @@ func (BuildConfigSpec) SwaggerDoc() map[string]string { var map_BuildConfigStatus = map[string]string{ "": "BuildConfigStatus contains current state of the build config object.", "lastVersion": "lastVersion is used to inform about number of last triggered build.", - "imageChangeTriggers": "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.", + "imageChangeTriggers": "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.", } func (BuildConfigStatus) SwaggerDoc() map[string]string { @@ -140,7 +140,7 @@ var map_BuildLogOptions = map[string]string{ "timestamps": "timestamps, If true, add an RFC3339 or RFC3339Nano timestamp at the beginning of every line of log output. Defaults to false.", "tailLines": "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", "limitBytes": "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.", - "nowait": "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.", + "nowait": "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.", "version": "version of the build for which to view logs.", "insecureSkipTLSVerifyBackend": "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).", } @@ -152,7 +152,7 @@ func (BuildLogOptions) SwaggerDoc() map[string]string { var map_BuildOutput = map[string]string{ "": "BuildOutput is input to a build strategy and describes the container image that the strategy should produce.", "to": "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.", - "pushSecret": "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).", + "pushSecret": "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).", "imageLabels": "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.", } @@ -181,8 +181,8 @@ var map_BuildRequest = map[string]string{ "lastVersion": "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.", "env": "env contains additional environment variables you want to pass into a builder container.", "triggeredBy": "triggeredBy describes which triggers started the most recent update to the build configuration and contains information about those triggers.", - "dockerStrategyOptions": "DockerStrategyOptions contains additional docker-strategy specific options for the build", - "sourceStrategyOptions": "SourceStrategyOptions contains additional source-strategy specific options for the build", + "dockerStrategyOptions": "dockerStrategyOptions contains additional docker-strategy specific options for the build", + "sourceStrategyOptions": "sourceStrategyOptions contains additional source-strategy specific options for the build", } func (BuildRequest) SwaggerDoc() map[string]string { @@ -229,7 +229,7 @@ var map_BuildStatus = map[string]string{ "output": "output describes the container image the build has produced.", "stages": "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.", "logSnippet": "logSnippet is the last few lines of the build log. This value is only set for builds that failed.", - "conditions": "Conditions represents the latest available observations of a build's current state.", + "conditions": "conditions represents the latest available observations of a build's current state.", } func (BuildStatus) SwaggerDoc() map[string]string { @@ -260,7 +260,7 @@ var map_BuildStrategy = map[string]string{ "dockerStrategy": "dockerStrategy holds the parameters to the container image build strategy.", "sourceStrategy": "sourceStrategy holds the parameters to the Source build strategy.", "customStrategy": "customStrategy holds the parameters to the Custom build strategy", - "jenkinsPipelineStrategy": "JenkinsPipelineStrategy holds the parameters to the Jenkins Pipeline build strategy. Deprecated: use OpenShift Pipelines", + "jenkinsPipelineStrategy": "jenkinsPipelineStrategy holds the parameters to the Jenkins Pipeline build strategy. Deprecated: use OpenShift Pipelines", } func (BuildStrategy) SwaggerDoc() map[string]string { @@ -271,10 +271,10 @@ var map_BuildTriggerCause = map[string]string{ "": "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.", "message": "message is used to store a human readable message for why the build was triggered. E.g.: \"Manually triggered by user\", \"Configuration change\",etc.", "genericWebHook": "genericWebHook holds data about a builds generic webhook trigger.", - "githubWebHook": "gitHubWebHook represents data for a GitHub webhook that fired a specific build.", + "githubWebHook": "githubWebHook represents data for a GitHub webhook that fired a specific build.", "imageChangeBuild": "imageChangeBuild stores information about an imagechange event that triggered a new build.", - "gitlabWebHook": "GitLabWebHook represents data for a GitLab webhook that fired a specific build.", - "bitbucketWebHook": "BitbucketWebHook represents data for a Bitbucket webhook that fired a specific build.", + "gitlabWebHook": "gitlabWebHook represents data for a GitLab webhook that fired a specific build.", + "bitbucketWebHook": "bitbucketWebHook represents data for a Bitbucket webhook that fired a specific build.", } func (BuildTriggerCause) SwaggerDoc() map[string]string { @@ -347,8 +347,8 @@ func (CommonSpec) SwaggerDoc() map[string]string { var map_CommonWebHookCause = map[string]string{ "": "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.", - "revision": "Revision is the git source revision information of the trigger.", - "secret": "Secret is the obfuscated webhook secret that triggered a build.", + "revision": "revision is the git source revision information of the trigger.", + "secret": "secret is the obfuscated webhook secret that triggered a build.", } func (CommonWebHookCause) SwaggerDoc() map[string]string { @@ -422,7 +422,7 @@ var map_GenericWebHookEvent = map[string]string{ "type": "type is the type of source repository", "git": "git is the git information if the Type is BuildSourceGit", "env": "env contains additional environment variables you want to pass into a builder container. ValueFrom is not supported.", - "dockerStrategyOptions": "DockerStrategyOptions contains additional docker-strategy specific options for the build", + "dockerStrategyOptions": "dockerStrategyOptions contains additional docker-strategy specific options for the build", } func (GenericWebHookEvent) SwaggerDoc() map[string]string { @@ -451,7 +451,7 @@ func (GitHubWebHookCause) SwaggerDoc() map[string]string { var map_GitInfo = map[string]string{ "": "GitInfo is the aggregated git information for a generic webhook post", - "refs": "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", + "refs": "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", } func (GitInfo) SwaggerDoc() map[string]string { @@ -562,8 +562,8 @@ func (ImageStreamTagReference) SwaggerDoc() map[string]string { var map_JenkinsPipelineBuildStrategy = map[string]string{ "": "JenkinsPipelineBuildStrategy holds parameters specific to a Jenkins Pipeline build. Deprecated: use OpenShift Pipelines", - "jenkinsfilePath": "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.", - "jenkinsfile": "Jenkinsfile defines the optional raw contents of a Jenkinsfile which defines a Jenkins pipeline build.", + "jenkinsfilePath": "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.", + "jenkinsfile": "jenkinsfile defines the optional raw contents of a Jenkinsfile which defines a Jenkins pipeline build.", "env": "env contains additional environment variables you want to pass into a build pipeline.", } @@ -594,7 +594,7 @@ func (SecretBuildSource) SwaggerDoc() map[string]string { var map_SecretLocalReference = map[string]string{ "": "SecretLocalReference contains information that points to the local secret being used", - "name": "Name is the name of the resource in the same namespace being referenced", + "name": "name is the name of the resource in the same namespace being referenced", } func (SecretLocalReference) SwaggerDoc() map[string]string { @@ -639,7 +639,7 @@ func (SourceControlUser) SwaggerDoc() map[string]string { var map_SourceRevision = map[string]string{ "": "SourceRevision is the revision or commit information from the source for the build", "type": "type of the build source, may be one of 'Source', 'Dockerfile', 'Binary', or 'Images'", - "git": "Git contains information about git-based build source", + "git": "git contains information about git-based build source", } func (SourceRevision) SwaggerDoc() map[string]string { diff --git a/cloudnetwork/v1/generated.proto b/cloudnetwork/v1/generated.proto index 085b49b25e8..328de7c5a20 100644 --- a/cloudnetwork/v1/generated.proto +++ b/cloudnetwork/v1/generated.proto @@ -40,12 +40,10 @@ message CloudPrivateIPConfig { optional .k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1; // spec is the definition of the desired private IP request. - // +kubebuilder:validation:Required // +required optional CloudPrivateIPConfigSpec spec = 2; // status is the observed status of the desired private IP request. Read-only. - // +kubebuilder:validation:Optional // +optional optional CloudPrivateIPConfigStatus status = 3; } @@ -68,7 +66,6 @@ message CloudPrivateIPConfigList { // +k8s:openapi-gen=true message CloudPrivateIPConfigSpec { // node is the node name, as specified by the Kubernetes field: node.metadata.name - // +kubebuilder:validation:Optional // +optional optional string node = 1; } @@ -77,12 +74,10 @@ message CloudPrivateIPConfigSpec { // +k8s:openapi-gen=true message CloudPrivateIPConfigStatus { // node is the node name, as specified by the Kubernetes field: node.metadata.name - // +kubebuilder:validation:Optional // +optional optional string node = 1; // condition is the assignment condition of the private IP and its status - // +kubebuilder:validation:Required // +required repeated .k8s.io.apimachinery.pkg.apis.meta.v1.Condition conditions = 2; } diff --git a/cloudnetwork/v1/types.go b/cloudnetwork/v1/types.go index 4c19e44c3f0..de27f8eb604 100644 --- a/cloudnetwork/v1/types.go +++ b/cloudnetwork/v1/types.go @@ -33,11 +33,9 @@ type CloudPrivateIPConfig struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` // spec is the definition of the desired private IP request. - // +kubebuilder:validation:Required // +required Spec CloudPrivateIPConfigSpec `json:"spec" protobuf:"bytes,2,opt,name=spec"` // status is the observed status of the desired private IP request. Read-only. - // +kubebuilder:validation:Optional // +optional Status CloudPrivateIPConfigStatus `json:"status,omitempty" protobuf:"bytes,3,opt,name=status"` } @@ -46,7 +44,6 @@ type CloudPrivateIPConfig struct { // +k8s:openapi-gen=true type CloudPrivateIPConfigSpec struct { // node is the node name, as specified by the Kubernetes field: node.metadata.name - // +kubebuilder:validation:Optional // +optional Node string `json:"node" protobuf:"bytes,1,opt,name=node"` } @@ -55,11 +52,9 @@ type CloudPrivateIPConfigSpec struct { // +k8s:openapi-gen=true type CloudPrivateIPConfigStatus struct { // node is the node name, as specified by the Kubernetes field: node.metadata.name - // +kubebuilder:validation:Optional // +optional Node string `json:"node" protobuf:"bytes,1,opt,name=node"` // condition is the assignment condition of the private IP and its status - // +kubebuilder:validation:Required // +required Conditions []metav1.Condition `json:"conditions" protobuf:"bytes,2,rep,name=conditions"` } diff --git a/config/v1/types.go b/config/v1/types.go index d4d09e7feec..44b96eb3138 100644 --- a/config/v1/types.go +++ b/config/v1/types.go @@ -9,7 +9,7 @@ import ( // The namespace must be specified at the point of use. type ConfigMapFileReference struct { Name string `json:"name"` - // Key allows pointing to a specific key/value inside of the configmap. This is useful for logical file references. + // key allows pointing to a specific key/value inside of the configmap. This is useful for logical file references. Key string `json:"key,omitempty"` } @@ -17,7 +17,6 @@ type ConfigMapFileReference struct { // The namespace must be specified at the point of use. type ConfigMapNameReference struct { // name is the metadata.name of the referenced config map - // +kubebuilder:validation:Required // +required Name string `json:"name"` } @@ -26,7 +25,6 @@ type ConfigMapNameReference struct { // The namespace must be specified at the point of use. type SecretNameReference struct { // name is the metadata.name of the referenced secret - // +kubebuilder:validation:Required // +required Name string `json:"name"` } @@ -35,47 +33,47 @@ type SecretNameReference struct { type HTTPServingInfo struct { // ServingInfo is the HTTP serving information ServingInfo `json:",inline"` - // MaxRequestsInFlight is the number of concurrent requests allowed to the server. If zero, no limit. + // maxRequestsInFlight is the number of concurrent requests allowed to the server. If zero, no limit. MaxRequestsInFlight int64 `json:"maxRequestsInFlight"` - // RequestTimeoutSeconds is the number of seconds before requests are timed out. The default is 60 minutes, if + // requestTimeoutSeconds is the number of seconds before requests are timed out. The default is 60 minutes, if // -1 there is no limit on requests. RequestTimeoutSeconds int64 `json:"requestTimeoutSeconds"` } // ServingInfo holds information about serving web pages type ServingInfo struct { - // BindAddress is the ip:port to serve on + // bindAddress is the ip:port to serve on BindAddress string `json:"bindAddress"` - // BindNetwork is the type of network to bind to - defaults to "tcp4", accepts "tcp", + // bindNetwork is the type of network to bind to - defaults to "tcp4", accepts "tcp", // "tcp4", and "tcp6" BindNetwork string `json:"bindNetwork"` // CertInfo is the TLS cert info for serving secure traffic. // this is anonymous so that we can inline it for serialization CertInfo `json:",inline"` - // ClientCA is the certificate bundle for all the signers that you'll recognize for incoming client certificates + // clientCA is the certificate bundle for all the signers that you'll recognize for incoming client certificates // +optional ClientCA string `json:"clientCA,omitempty"` - // NamedCertificates is a list of certificates to use to secure requests to specific hostnames + // namedCertificates is a list of certificates to use to secure requests to specific hostnames NamedCertificates []NamedCertificate `json:"namedCertificates,omitempty"` - // MinTLSVersion is the minimum TLS version supported. + // minTLSVersion is the minimum TLS version supported. // Values must match version names from https://golang.org/pkg/crypto/tls/#pkg-constants MinTLSVersion string `json:"minTLSVersion,omitempty"` - // CipherSuites contains an overridden list of ciphers for the server to support. + // 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 CipherSuites []string `json:"cipherSuites,omitempty"` } // CertInfo relates a certificate with a private key type CertInfo struct { - // CertFile is a file containing a PEM-encoded certificate + // certFile is a file containing a PEM-encoded certificate CertFile string `json:"certFile"` - // KeyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile + // keyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile KeyFile string `json:"keyFile"` } // NamedCertificate specifies a certificate/key, and the names it should be served for type NamedCertificate struct { - // Names is a list of DNS names this certificate should be used to secure + // 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. Names []string `json:"names,omitempty"` // CertInfo is the TLS cert info for serving secure traffic @@ -121,24 +119,24 @@ type StringSource struct { // StringSourceSpec specifies a string value, or external location type StringSourceSpec struct { - // Value specifies the cleartext value, or an encrypted value if keyFile is specified. + // value specifies the cleartext value, or an encrypted value if keyFile is specified. Value string `json:"value"` - // Env specifies an envvar containing the cleartext value, or an encrypted value if the keyFile is specified. + // env specifies an envvar containing the cleartext value, or an encrypted value if the keyFile is specified. Env string `json:"env"` - // File references a file containing the cleartext value, or an encrypted value if a keyFile is specified. + // file references a file containing the cleartext value, or an encrypted value if a keyFile is specified. File string `json:"file"` - // KeyFile references a file containing the key to use to decrypt the value. + // keyFile references a file containing the key to use to decrypt the value. KeyFile string `json:"keyFile"` } // RemoteConnectionInfo holds information necessary for establishing a remote connection type RemoteConnectionInfo struct { - // URL is the remote URL to connect to + // url is the remote URL to connect to URL string `json:"url"` - // CA is the CA for verifying TLS connections + // ca is the CA for verifying TLS connections CA string `json:"ca"` // CertInfo is the TLS client cert information to present // this is anonymous so that we can inline it for serialization @@ -160,11 +158,11 @@ type AdmissionConfig struct { // AdmissionPluginConfig holds the necessary configuration options for admission plugins type AdmissionPluginConfig struct { - // Location is the path to a configuration file that contains the plugin's + // location is the path to a configuration file that contains the plugin's // configuration Location string `json:"location"` - // Configuration is an embedded configuration object to be used as the plugin's + // 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. // +nullable // +kubebuilder:pruning:PreserveUnknownFields @@ -205,9 +203,9 @@ type AuditConfig struct { // Maximum size in megabytes of the log file before it gets rotated. Defaults to 100MB. MaximumFileSizeMegabytes int32 `json:"maximumFileSizeMegabytes"` - // PolicyFile is a path to the file that defines the audit policy configuration. + // policyFile is a path to the file that defines the audit policy configuration. PolicyFile string `json:"policyFile"` - // PolicyConfiguration is an embedded policy configuration object to be used + // 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. // +nullable @@ -324,7 +322,6 @@ type RequiredHSTSPolicy struct { // The 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*. // +kubebuilder:validation:MinItems=1 - // +kubebuilder:validation:Required // +required DomainPatterns []string `json:"domainPatterns"` diff --git a/config/v1/types_apiserver.go b/config/v1/types_apiserver.go index d815556d28c..75b647f745c 100644 --- a/config/v1/types_apiserver.go +++ b/config/v1/types_apiserver.go @@ -27,7 +27,6 @@ type APIServer struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata,omitempty"` // spec holds user settable values for configuration - // +kubebuilder:validation:Required // +required Spec APIServerSpec `json:"spec"` // status holds observed values from the cluster. They may not be overridden. @@ -129,7 +128,6 @@ type Audit struct { type AuditCustomRule struct { // group is a name of group a request user must be member of in order to this profile to apply. // - // +kubebuilder:validation:Required // +kubebuilder:validation:MinLength=1 // +required Group string `json:"group"` @@ -146,7 +144,6 @@ type AuditCustomRule struct { // // If unset, the 'Default' profile is used as the default. // - // +kubebuilder:validation:Required // +required Profile AuditProfileType `json:"profile,omitempty"` } diff --git a/config/v1/types_authentication.go b/config/v1/types_authentication.go index f6f0c12a3be..65dffddb00f 100644 --- a/config/v1/types_authentication.go +++ b/config/v1/types_authentication.go @@ -26,7 +26,6 @@ type Authentication struct { metav1.ObjectMeta `json:"metadata,omitempty"` // spec holds user settable values for configuration - // +kubebuilder:validation:Required // +required Spec AuthenticationSpec `json:"spec"` // status holds observed values from the cluster. They may not be overridden. @@ -81,7 +80,7 @@ type AuthenticationSpec struct { // +optional ServiceAccountIssuer string `json:"serviceAccountIssuer"` - // OIDCProviders are OIDC identity providers that can issue tokens + // oidcProviders are OIDC identity providers that can issue tokens // for this cluster // Can only be set if "Type" is set to "OIDC". // @@ -110,7 +109,7 @@ type AuthenticationStatus struct { // The namespace for this config map is openshift-config-managed. IntegratedOAuthMetadata ConfigMapNameReference `json:"integratedOAuthMetadata"` - // OIDCClients is where participating operators place the current OIDC client status + // oidcClients is where participating operators place the current OIDC client status // for OIDC clients that can be customized by the cluster-admin. // // +listType=map @@ -181,7 +180,6 @@ type WebhookTokenAuthenticator struct { // 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. - // +kubebuilder:validation:Required // +required KubeConfig SecretNameReference `json:"kubeConfig"` } @@ -195,19 +193,17 @@ const ( ) type OIDCProvider struct { - // Name of the OIDC provider + // name of the OIDC provider // // +kubebuilder:validation:MinLength=1 - // +kubebuilder:validation:Required // +required Name string `json:"name"` - // Issuer describes atributes of the OIDC token issuer + // issuer describes atributes of the OIDC token issuer // - // +kubebuilder:validation:Required // +required Issuer TokenIssuer `json:"issuer"` - // OIDCClients contains configuration for the platform's clients that + // oidcClients contains configuration for the platform's clients that // need to request tokens from the issuer // // +listType=map @@ -216,11 +212,11 @@ type OIDCProvider struct { // +kubebuilder:validation:MaxItems=20 OIDCClients []OIDCClientConfig `json:"oidcClients"` - // ClaimMappings describes rules on how to transform information from an + // claimMappings describes rules on how to transform information from an // ID token into a cluster identity ClaimMappings TokenClaimMappings `json:"claimMappings"` - // ClaimValidationRules are rules that are applied to validate token claims to authenticate users. + // claimValidationRules are rules that are applied to validate token claims to authenticate users. // // +listType=atomic ClaimValidationRules []TokenClaimValidationRule `json:"claimValidationRules,omitempty"` @@ -234,17 +230,15 @@ type TokenIssuer struct { // Must use the https:// scheme. // // +kubebuilder:validation:Pattern=`^https:\/\/[^\s]` - // +kubebuilder:validation:Required // +required URL string `json:"issuerURL"` - // Audiences is an array of audiences that the token was issued for. + // audiences is an array of audiences that the token was issued for. // Valid tokens must include at least one of these values in their // "aud" claim. // Must be set to exactly one value. // // +listType=set - // +kubebuilder:validation:Required // +kubebuilder:validation:MinItems=1 // +kubebuilder:validation:MaxItems=10 // +required @@ -258,94 +252,88 @@ type TokenIssuer struct { } type TokenClaimMappings struct { - // Username is a name of the claim that should be used to construct + // username is a name of the claim that should be used to construct // usernames for the cluster identity. // // Default value: "sub" Username UsernameClaimMapping `json:"username,omitempty"` - // Groups is a name of the claim that should be used to construct + // groups is a name of the claim that should be used to construct // groups for the cluster identity. // The referenced claim must use array of strings values. Groups PrefixedClaimMapping `json:"groups,omitempty"` } type TokenClaimMapping struct { - // Claim is a JWT token claim to be used in the mapping + // claim is a JWT token claim to be used in the mapping // - // +kubebuilder:validation:Required // +required Claim string `json:"claim"` } type OIDCClientConfig struct { - // ComponentName is the name of the component that is supposed to consume this + // componentName is the name of the component that is supposed to consume this // client configuration // // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=256 - // +kubebuilder:validation:Required // +required ComponentName string `json:"componentName"` - // ComponentNamespace is the namespace of the component that is supposed to consume this + // componentNamespace is the namespace of the component that is supposed to consume this // client configuration // // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=63 - // +kubebuilder:validation:Required // +required ComponentNamespace string `json:"componentNamespace"` - // ClientID is the identifier of the OIDC client from the OIDC provider + // clientID is the identifier of the OIDC client from the OIDC provider // // +kubebuilder:validation:MinLength=1 - // +kubebuilder:validation:Required // +required ClientID string `json:"clientID"` - // ClientSecret refers to a secret in the `openshift-config` namespace that + // clientSecret refers to a secret in the `openshift-config` namespace that // contains the client secret in the `clientSecret` key of the `.data` field ClientSecret SecretNameReference `json:"clientSecret"` - // ExtraScopes is an optional set of scopes to request tokens with. + // extraScopes is an optional set of scopes to request tokens with. // // +listType=set ExtraScopes []string `json:"extraScopes"` } type OIDCClientStatus struct { - // ComponentName is the name of the component that will consume a client configuration. + // componentName is the name of the component that will consume a client configuration. // // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=256 - // +kubebuilder:validation:Required // +required ComponentName string `json:"componentName"` - // ComponentNamespace is the namespace of the component that will consume a client configuration. + // componentNamespace is the namespace of the component that will consume a client configuration. // // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=63 - // +kubebuilder:validation:Required // +required ComponentNamespace string `json:"componentNamespace"` - // CurrentOIDCClients is a list of clients that the component is currently using. + // currentOIDCClients is a list of clients that the component is currently using. // // +listType=map // +listMapKey=issuerURL // +listMapKey=clientID CurrentOIDCClients []OIDCClientReference `json:"currentOIDCClients"` - // ConsumingUsers is a slice of ServiceAccounts that need to have read + // consumingUsers is a slice of ServiceAccounts that need to have read // permission on the `clientSecret` secret. // // +kubebuilder:validation:MaxItems=5 // +listType=set ConsumingUsers []ConsumingUser `json:"consumingUsers"` - // Conditions are used to communicate the state of the `oidcClients` entry. + // conditions are used to communicate the state of the `oidcClients` entry. // // Supported conditions include Available, Degraded and Progressing. // @@ -362,7 +350,6 @@ type OIDCClientReference struct { // OIDCName refers to the `name` of the provider from `oidcProviders` // // +kubebuilder:validation:MinLength=1 - // +kubebuilder:validation:Required // +required OIDCProviderName string `json:"oidcProviderName"` @@ -370,14 +357,12 @@ type OIDCClientReference struct { // Must use the https:// scheme. // // +kubebuilder:validation:Pattern=`^https:\/\/[^\s]` - // +kubebuilder:validation:Required // +required IssuerURL string `json:"issuerURL"` - // ClientID is the identifier of the OIDC client from the OIDC provider + // clientID is the identifier of the OIDC client from the OIDC provider // // +kubebuilder:validation:MinLength=1 - // +kubebuilder:validation:Required // +required ClientID string `json:"clientID"` } @@ -386,7 +371,7 @@ type OIDCClientReference struct { type UsernameClaimMapping struct { TokenClaimMapping `json:",inline"` - // PrefixPolicy specifies how a prefix should apply. + // prefixPolicy specifies how a prefix should apply. // // By default, claims other than `email` will be prefixed with the issuer URL to // prevent naming clashes with other plugins. @@ -427,7 +412,6 @@ var ( ) type UsernamePrefix struct { - // +kubebuilder:validation:Required // +kubebuilder:validation:MinLength=1 // +required PrefixString string `json:"prefixString"` @@ -436,7 +420,7 @@ type UsernamePrefix struct { type PrefixedClaimMapping struct { TokenClaimMapping `json:",inline"` - // Prefix is a string to prefix the value from the token in the result of the + // prefix is a string to prefix the value from the token in the result of the // claim mapping. // // By default, no prefixing occurs. @@ -454,30 +438,28 @@ const ( ) type TokenClaimValidationRule struct { - // Type sets the type of the validation rule + // type sets the type of the validation rule // // +kubebuilder:validation:Enum={"RequiredClaim"} // +kubebuilder:default="RequiredClaim" Type TokenValidationRuleType `json:"type"` - // RequiredClaim allows configuring a required claim name and its expected + // requiredClaim allows configuring a required claim name and its expected // value RequiredClaim *TokenRequiredClaim `json:"requiredClaim"` } type TokenRequiredClaim struct { - // Claim is a name of a required claim. Only claims with string values are + // claim is a name of a required claim. Only claims with string values are // supported. // // +kubebuilder:validation:MinLength=1 - // +kubebuilder:validation:Required // +required Claim string `json:"claim"` - // RequiredValue is the required value for the claim. + // requiredValue is the required value for the claim. // // +kubebuilder:validation:MinLength=1 - // +kubebuilder:validation:Required // +required RequiredValue string `json:"requiredValue"` } diff --git a/config/v1/types_build.go b/config/v1/types_build.go index dad47666db6..a1961ef1f81 100644 --- a/config/v1/types_build.go +++ b/config/v1/types_build.go @@ -29,14 +29,13 @@ type Build struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata,omitempty"` - // Spec holds user-settable values for the build controller configuration - // +kubebuilder:validation:Required + // spec holds user-settable values for the build controller configuration // +required Spec BuildSpec `json:"spec"` } type BuildSpec struct { - // AdditionalTrustedCA is a reference to a ConfigMap containing additional CAs that + // 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. // @@ -45,16 +44,16 @@ type BuildSpec struct { // // +optional AdditionalTrustedCA ConfigMapNameReference `json:"additionalTrustedCA"` - // BuildDefaults controls the default information for Builds + // buildDefaults controls the default information for Builds // +optional BuildDefaults BuildDefaults `json:"buildDefaults"` - // BuildOverrides controls override settings for builds + // buildOverrides controls override settings for builds // +optional BuildOverrides BuildOverrides `json:"buildOverrides"` } type BuildDefaults struct { - // DefaultProxy contains the default proxy settings for all build operations, including image pull/push + // defaultProxy contains the default proxy settings for all build operations, including image pull/push // and source download. // // Values can be overrode by setting the `HTTP_PROXY`, `HTTPS_PROXY`, and `NO_PROXY` environment variables @@ -62,46 +61,46 @@ type BuildDefaults struct { // +optional DefaultProxy *ProxySpec `json:"defaultProxy,omitempty"` - // GitProxy contains the proxy settings for git operations only. If set, this will override + // 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. // // Values that are not set here will be inherited from DefaultProxy. // +optional GitProxy *ProxySpec `json:"gitProxy,omitempty"` - // Env is a set of default environment variables that will be applied to the + // 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 // +optional Env []corev1.EnvVar `json:"env,omitempty"` - // ImageLabels is a list of docker labels that are applied to the resulting image. + // 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. // +optional ImageLabels []ImageLabel `json:"imageLabels,omitempty"` - // Resources defines resource requirements to execute the build. + // resources defines resource requirements to execute the build. // +optional Resources corev1.ResourceRequirements `json:"resources"` } type ImageLabel struct { - // Name defines the name of the label. It must have non-zero length. + // name defines the name of the label. It must have non-zero length. Name string `json:"name"` - // Value defines the literal value of the label. + // value defines the literal value of the label. // +optional Value string `json:"value,omitempty"` } type BuildOverrides struct { - // ImageLabels is a list of docker labels that are applied to the resulting image. + // 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. // +optional ImageLabels []ImageLabel `json:"imageLabels,omitempty"` - // NodeSelector is a selector which must be true for the build pod to fit on a node + // nodeSelector is a selector which must be true for the build pod to fit on a node // +optional NodeSelector map[string]string `json:"nodeSelector,omitempty"` diff --git a/config/v1/types_cluster_operator.go b/config/v1/types_cluster_operator.go index 7951762ccd5..4a6823640d5 100644 --- a/config/v1/types_cluster_operator.go +++ b/config/v1/types_cluster_operator.go @@ -34,7 +34,6 @@ type ClusterOperator struct { metav1.ObjectMeta `json:"metadata"` // spec holds configuration that could apply to any operator. - // +kubebuilder:validation:Required // +required Spec ClusterOperatorSpec `json:"spec"` @@ -80,14 +79,12 @@ type ClusterOperatorStatus struct { type OperandVersion struct { // name is the name of the particular operand this version is for. It usually matches container images, not operators. - // +kubebuilder:validation:Required // +required Name string `json:"name"` // 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 - // +kubebuilder:validation:Required // +required Version string `json:"version"` } @@ -95,18 +92,15 @@ type OperandVersion struct { // ObjectReference contains enough information to let you inspect or modify the referred object. type ObjectReference struct { // group of the referent. - // +kubebuilder:validation:Required // +required Group string `json:"group"` // resource of the referent. - // +kubebuilder:validation:Required // +required Resource string `json:"resource"` // namespace of the referent. // +optional Namespace string `json:"namespace,omitempty"` // name of the referent. - // +kubebuilder:validation:Required // +required Name string `json:"name"` } @@ -128,17 +122,14 @@ const ( // +k8s:deepcopy-gen=true type ClusterOperatorStatusCondition struct { // type specifies the aspect reported by this condition. - // +kubebuilder:validation:Required // +required Type ClusterStatusConditionType `json:"type"` // status of the condition, one of True, False, Unknown. - // +kubebuilder:validation:Required // +required Status ConditionStatus `json:"status"` // lastTransitionTime is the time of the last update to the current status property. - // +kubebuilder:validation:Required // +required LastTransitionTime metav1.Time `json:"lastTransitionTime"` diff --git a/config/v1/types_cluster_version.go b/config/v1/types_cluster_version.go index 2b392298e89..8994ca97cdd 100644 --- a/config/v1/types_cluster_version.go +++ b/config/v1/types_cluster_version.go @@ -34,7 +34,6 @@ type ClusterVersion struct { // spec is the desired state of the cluster version - the operator will work // to ensure that the desired version is applied to the cluster. - // +kubebuilder:validation:Required // +required Spec ClusterVersionSpec `json:"spec"` // status contains information about the available updates and any in-progress @@ -51,7 +50,6 @@ type ClusterVersionSpec struct { // 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. - // +kubebuilder:validation:Required // +required ClusterID ClusterID `json:"clusterID"` @@ -138,7 +136,6 @@ type ClusterVersionStatus struct { // 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. - // +kubebuilder:validation:Required // +required Desired Release `json:"desired"` @@ -156,14 +153,12 @@ type ClusterVersionStatus struct { // 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. - // +kubebuilder:validation:Required // +required ObservedGeneration int64 `json:"observedGeneration"` // 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. - // +kubebuilder:validation:Required // +required VersionHash string `json:"versionHash"` @@ -190,7 +185,6 @@ type ClusterVersionStatus struct { // may be empty if no updates are recommended, if the update service // is unavailable, or if an invalid channel has been specified. // +nullable - // +kubebuilder:validation:Required // +listType=atomic // +required AvailableUpdates []Release `json:"availableUpdates"` @@ -226,12 +220,10 @@ type UpdateHistory struct { // 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). - // +kubebuilder:validation:Required // +required State UpdateState `json:"state"` // startedTime is the time at which the update was started. - // +kubebuilder:validation:Required // +required StartedTime metav1.Time `json:"startedTime"` @@ -239,7 +231,6 @@ type UpdateHistory struct { // 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). - // +kubebuilder:validation:Required // +required // +nullable CompletionTime *metav1.Time `json:"completionTime"` @@ -253,7 +244,6 @@ type UpdateHistory struct { // image is a container image location that contains the update. This value // is always populated. - // +kubebuilder:validation:Required // +required Image string `json:"image"` @@ -261,7 +251,6 @@ type UpdateHistory struct { // 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. - // +kubebuilder:validation:Required // +required Verified bool `json:"verified"` @@ -671,28 +660,23 @@ type ClusterVersionCapabilitiesStatus struct { // +k8s:deepcopy-gen=true type ComponentOverride struct { // kind indentifies which object to override. - // +kubebuilder:validation:Required // +required Kind string `json:"kind"` // group identifies the API group that the kind is in. - // +kubebuilder:validation:Required // +required Group string `json:"group"` // namespace is the component's namespace. If the resource is cluster // scoped, the namespace should be empty. - // +kubebuilder:validation:Required // +required Namespace string `json:"namespace"` // name is the component's name. - // +kubebuilder:validation:Required // +required Name string `json:"name"` // unmanaged controls if cluster version operator should stop managing the // resources in this cluster. // Default: false - // +kubebuilder:validation:Required // +required Unmanaged bool `json:"unmanaged"` } @@ -701,8 +685,8 @@ type ComponentOverride struct { type URL string // Update represents an administrator update request. -// +kubebuilder:validation:XValidation:rule="has(self.architecture) && has(self.image) ? (self.architecture == '' || self.image == '') : true",message="cannot set both Architecture and Image" -// +kubebuilder:validation:XValidation:rule="has(self.architecture) && self.architecture != '' ? self.version != '' : true",message="Version must be set if Architecture is set" +// +kubebuilder:validation:XValidation:rule="has(self.architecture) && has(self.image) ? (self.architecture == \"\" || self.image == \"\") : true",message="cannot set both Architecture and Image" +// +kubebuilder:validation:XValidation:rule="has(self.architecture) && self.architecture != \"\" ? self.version != \"\" : true",message="Version must be set if Architecture is set" // +k8s:deepcopy-gen=true type Update struct { // architecture is an optional field that indicates the desired @@ -793,7 +777,6 @@ const RetrievedUpdates ClusterStatusConditionType = "RetrievedUpdates" // may not be recommended for the current cluster. type ConditionalUpdate struct { // release is the target of the update. - // +kubebuilder:validation:Required // +required Release Release `json:"release"` @@ -802,7 +785,6 @@ type ConditionalUpdate struct { // operator will evaluate all entries, and only recommend the // update if there is at least one entry and all entries // recommend the update. - // +kubebuilder:validation:Required // +kubebuilder:validation:MinItems=1 // +patchMergeKey=name // +patchStrategy=merge @@ -826,7 +808,6 @@ type ConditionalUpdate struct { // +k8s:deepcopy-gen=true type ConditionalUpdateRisk struct { // url contains information about this risk. - // +kubebuilder:validation:Required // +kubebuilder:validation:Format=uri // +kubebuilder:validation:MinLength=1 // +required @@ -835,7 +816,6 @@ type ConditionalUpdateRisk struct { // name is the CamelCase reason for not recommending a // conditional update, in the event that matchingRules match the // cluster state. - // +kubebuilder:validation:Required // +kubebuilder:validation:MinLength=1 // +required Name string `json:"name"` @@ -845,7 +825,6 @@ type ConditionalUpdateRisk struct { // state. This is only to be consumed by humans. It may // contain Line Feed characters (U+000A), which should be // rendered as new lines. - // +kubebuilder:validation:Required // +kubebuilder:validation:MinLength=1 // +required Message string `json:"message"` @@ -856,7 +835,6 @@ type ConditionalUpdateRisk struct { // 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. - // +kubebuilder:validation:Required // +kubebuilder:validation:MinItems=1 // +listType=atomic // +required @@ -871,24 +849,22 @@ type ConditionalUpdateRisk struct { type ClusterCondition struct { // type represents the cluster-condition type. This defines // the members and semantics of any additional properties. - // +kubebuilder:validation:Required // +kubebuilder:validation:Enum={"Always","PromQL"} // +required Type string `json:"type"` - // promQL represents a cluster condition based on PromQL. + // promql represents a cluster condition based on PromQL. // +optional PromQL *PromQLClusterCondition `json:"promql,omitempty"` } // PromQLClusterCondition represents a cluster condition based on PromQL. type PromQLClusterCondition struct { - // PromQL is a PromQL query classifying clusters. This query + // 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. - // +kubebuilder:validation:Required // +required PromQL string `json:"promql"` } @@ -917,7 +893,7 @@ type SignatureStore struct { // // +kubebuilder:validation:Type=string // +kubebuilder:validation:XValidation:rule="isURL(self)",message="url must be a valid absolute URL" - // +kubebuilder:validation:Required + // +required URL string `json:"url"` // ca is an optional reference to a config map by name containing the PEM-encoded CA bundle. diff --git a/config/v1/types_console.go b/config/v1/types_console.go index e8f197b3447..0ccc4a8f85e 100644 --- a/config/v1/types_console.go +++ b/config/v1/types_console.go @@ -28,7 +28,6 @@ type Console struct { metav1.ObjectMeta `json:"metadata,omitempty"` // spec holds user settable values for configuration - // +kubebuilder:validation:Required // +required Spec ConsoleSpec `json:"spec"` // status holds observed values from the cluster. They may not be overridden. diff --git a/config/v1/types_dns.go b/config/v1/types_dns.go index 5daa5d78d26..06eb75ccf70 100644 --- a/config/v1/types_dns.go +++ b/config/v1/types_dns.go @@ -24,7 +24,6 @@ type DNS struct { metav1.ObjectMeta `json:"metadata,omitempty"` // spec holds user settable values for configuration - // +kubebuilder:validation:Required // +required Spec DNSSpec `json:"spec"` // status holds observed values from the cluster. They may not be overridden. @@ -121,7 +120,7 @@ type DNSPlatformSpec struct { // and must handle unrecognized platforms with best-effort defaults. // // +unionDiscriminator - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:XValidation:rule="self in ['','AWS']",message="allowed values are '' and 'AWS'" Type PlatformType `json:"type"` diff --git a/config/v1/types_feature.go b/config/v1/types_feature.go index 88d94ac5276..81bc14f2c74 100644 --- a/config/v1/types_feature.go +++ b/config/v1/types_feature.go @@ -26,7 +26,6 @@ type FeatureGate struct { metav1.ObjectMeta `json:"metadata,omitempty"` // spec holds user settable values for configuration - // +kubebuilder:validation:Required // +required // +kubebuilder:validation:XValidation:rule="has(oldSelf.featureSet) ? has(self.featureSet) : true",message=".spec.featureSet cannot be removed" Spec FeatureGateSpec `json:"spec"` @@ -117,7 +116,6 @@ type FeatureGateStatus struct { type FeatureGateDetails struct { // version matches the version provided by the ClusterVersion and in the ClusterOperator.Status.Versions field. - // +kubebuilder:validation:Required // +required Version string `json:"version"` // enabled is a list of all feature gates that are enabled in the cluster for the named version. @@ -130,7 +128,7 @@ type FeatureGateDetails struct { type FeatureGateAttributes struct { // name is the name of the FeatureGate. - // +kubebuilder:validation:Required + // +required Name FeatureGateName `json:"name"` // possible (probable?) future additions include diff --git a/config/v1/types_image.go b/config/v1/types_image.go index d3c694a56f3..3db935c7fe4 100644 --- a/config/v1/types_image.go +++ b/config/v1/types_image.go @@ -29,7 +29,6 @@ type Image struct { metav1.ObjectMeta `json:"metadata,omitempty"` // spec holds user settable values for configuration - // +kubebuilder:validation:Required // +required Spec ImageSpec `json:"spec"` // status holds observed values from the cluster. They may not be overridden. diff --git a/config/v1/types_image_content_policy.go b/config/v1/types_image_content_policy.go index 74df4027f91..0bd0d777055 100644 --- a/config/v1/types_image_content_policy.go +++ b/config/v1/types_image_content_policy.go @@ -25,7 +25,6 @@ type ImageContentPolicy struct { metav1.ObjectMeta `json:"metadata,omitempty"` // spec holds user settable values for configuration - // +kubebuilder:validation:Required // +required Spec ImageContentPolicySpec `json:"spec"` } @@ -76,7 +75,6 @@ type ImageContentPolicyList struct { type RepositoryDigestMirrors struct { // source is the repository that users refer to, e.g. in image pull specifications. // +required - // +kubebuilder:validation:Required // +kubebuilder:validation:Pattern=`^(([a-zA-Z]|[a-zA-Z][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z]|[A-Za-z][A-Za-z0-9\-]*[A-Za-z0-9])(:[0-9]+)?(\/[^\/:\n]+)*(\/[^\/:\n]+((:[^\/:\n]+)|(@[^\n]+)))?$` Source string `json:"source"` // 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. diff --git a/config/v1/types_image_digest_mirror_set.go b/config/v1/types_image_digest_mirror_set.go index 43d748c0c32..df2258d12fc 100644 --- a/config/v1/types_image_digest_mirror_set.go +++ b/config/v1/types_image_digest_mirror_set.go @@ -25,7 +25,6 @@ type ImageDigestMirrorSet struct { metav1.ObjectMeta `json:"metadata,omitempty"` // spec holds user settable values for configuration - // +kubebuilder:validation:Required // +required Spec ImageDigestMirrorSetSpec `json:"spec"` // status contains the observed state of the resource. @@ -110,7 +109,6 @@ type ImageDigestMirrors struct { // 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 // +required - // +kubebuilder:validation:Required // +kubebuilder:validation:Pattern=`^\*(?:\.(?:[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]))+$|^((?:[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9])(?:(?:\.(?:[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]))+)?(?::[0-9]+)?)(?:(?:/[a-z0-9]+(?:(?:(?:[._]|__|[-]*)[a-z0-9]+)+)?)+)?$` Source string `json:"source"` // mirrors is zero or more locations that may also contain the same images. No mirror will be configured if not specified. diff --git a/config/v1/types_image_tag_mirror_set.go b/config/v1/types_image_tag_mirror_set.go index ca8d35515e9..b7e1a6a8732 100644 --- a/config/v1/types_image_tag_mirror_set.go +++ b/config/v1/types_image_tag_mirror_set.go @@ -25,7 +25,6 @@ type ImageTagMirrorSet struct { metav1.ObjectMeta `json:"metadata,omitempty"` // spec holds user settable values for configuration - // +kubebuilder:validation:Required // +required Spec ImageTagMirrorSetSpec `json:"spec"` // status contains the observed state of the resource. @@ -95,7 +94,6 @@ type ImageTagMirrors struct { // 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 // +required - // +kubebuilder:validation:Required // +kubebuilder:validation:Pattern=`^\*(?:\.(?:[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]))+$|^((?:[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9])(?:(?:\.(?:[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]))+)?(?::[0-9]+)?)(?:(?:/[a-z0-9]+(?:(?:(?:[._]|__|[-]*)[a-z0-9]+)+)?)+)?$` Source string `json:"source"` // mirrors is zero or more locations that may also contain the same images. No mirror will be configured if not specified. diff --git a/config/v1/types_infrastructure.go b/config/v1/types_infrastructure.go index 1ebe2dfb9cd..24aaf1c8f6f 100644 --- a/config/v1/types_infrastructure.go +++ b/config/v1/types_infrastructure.go @@ -27,7 +27,6 @@ type Infrastructure struct { metav1.ObjectMeta `json:"metadata,omitempty"` // spec holds user settable values for configuration - // +kubebuilder:validation:Required // +required Spec InfrastructureSpec `json:"spec"` // status holds observed values from the cluster. They may not be overridden. @@ -257,7 +256,7 @@ const ( // ExternalPlatformSpec holds the desired state for the generic External infrastructure provider. type ExternalPlatformSpec struct { - // PlatformName holds the arbitrary string representing the infrastructure provider name, expected to be set at the installation time. + // 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. // +kubebuilder:default:="Unknown" // +default="Unknown" @@ -283,55 +282,55 @@ type PlatformSpec struct { // +unionDiscriminator Type PlatformType `json:"type"` - // AWS contains settings specific to the Amazon Web Services infrastructure provider. + // aws contains settings specific to the Amazon Web Services infrastructure provider. // +optional AWS *AWSPlatformSpec `json:"aws,omitempty"` - // Azure contains settings specific to the Azure infrastructure provider. + // azure contains settings specific to the Azure infrastructure provider. // +optional Azure *AzurePlatformSpec `json:"azure,omitempty"` - // GCP contains settings specific to the Google Cloud Platform infrastructure provider. + // gcp contains settings specific to the Google Cloud Platform infrastructure provider. // +optional GCP *GCPPlatformSpec `json:"gcp,omitempty"` - // BareMetal contains settings specific to the BareMetal platform. + // baremetal contains settings specific to the BareMetal platform. // +optional BareMetal *BareMetalPlatformSpec `json:"baremetal,omitempty"` - // OpenStack contains settings specific to the OpenStack infrastructure provider. + // openstack contains settings specific to the OpenStack infrastructure provider. // +optional OpenStack *OpenStackPlatformSpec `json:"openstack,omitempty"` - // Ovirt contains settings specific to the oVirt infrastructure provider. + // ovirt contains settings specific to the oVirt infrastructure provider. // +optional Ovirt *OvirtPlatformSpec `json:"ovirt,omitempty"` - // VSphere contains settings specific to the VSphere infrastructure provider. + // vsphere contains settings specific to the VSphere infrastructure provider. // +optional VSphere *VSpherePlatformSpec `json:"vsphere,omitempty"` - // IBMCloud contains settings specific to the IBMCloud infrastructure provider. + // ibmcloud contains settings specific to the IBMCloud infrastructure provider. // +optional IBMCloud *IBMCloudPlatformSpec `json:"ibmcloud,omitempty"` - // Kubevirt contains settings specific to the kubevirt infrastructure provider. + // kubevirt contains settings specific to the kubevirt infrastructure provider. // +optional Kubevirt *KubevirtPlatformSpec `json:"kubevirt,omitempty"` - // EquinixMetal contains settings specific to the Equinix Metal infrastructure provider. + // equinixMetal contains settings specific to the Equinix Metal infrastructure provider. // +optional EquinixMetal *EquinixMetalPlatformSpec `json:"equinixMetal,omitempty"` - // PowerVS contains settings specific to the IBM Power Systems Virtual Servers infrastructure provider. + // powervs contains settings specific to the IBM Power Systems Virtual Servers infrastructure provider. // +optional PowerVS *PowerVSPlatformSpec `json:"powervs,omitempty"` - // AlibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. + // alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. // +optional AlibabaCloud *AlibabaCloudPlatformSpec `json:"alibabaCloud,omitempty"` - // Nutanix contains settings specific to the Nutanix infrastructure provider. + // nutanix contains settings specific to the Nutanix infrastructure provider. // +optional Nutanix *NutanixPlatformSpec `json:"nutanix,omitempty"` @@ -401,59 +400,59 @@ type PlatformStatus struct { // Currently this value cannot be changed once set. Type PlatformType `json:"type"` - // AWS contains settings specific to the Amazon Web Services infrastructure provider. + // aws contains settings specific to the Amazon Web Services infrastructure provider. // +optional AWS *AWSPlatformStatus `json:"aws,omitempty"` - // Azure contains settings specific to the Azure infrastructure provider. + // azure contains settings specific to the Azure infrastructure provider. // +optional Azure *AzurePlatformStatus `json:"azure,omitempty"` - // GCP contains settings specific to the Google Cloud Platform infrastructure provider. + // gcp contains settings specific to the Google Cloud Platform infrastructure provider. // +optional GCP *GCPPlatformStatus `json:"gcp,omitempty"` - // BareMetal contains settings specific to the BareMetal platform. + // baremetal contains settings specific to the BareMetal platform. // +optional BareMetal *BareMetalPlatformStatus `json:"baremetal,omitempty"` - // OpenStack contains settings specific to the OpenStack infrastructure provider. + // openstack contains settings specific to the OpenStack infrastructure provider. // +optional OpenStack *OpenStackPlatformStatus `json:"openstack,omitempty"` - // Ovirt contains settings specific to the oVirt infrastructure provider. + // ovirt contains settings specific to the oVirt infrastructure provider. // +optional Ovirt *OvirtPlatformStatus `json:"ovirt,omitempty"` - // VSphere contains settings specific to the VSphere infrastructure provider. + // vsphere contains settings specific to the VSphere infrastructure provider. // +optional VSphere *VSpherePlatformStatus `json:"vsphere,omitempty"` - // IBMCloud contains settings specific to the IBMCloud infrastructure provider. + // ibmcloud contains settings specific to the IBMCloud infrastructure provider. // +optional IBMCloud *IBMCloudPlatformStatus `json:"ibmcloud,omitempty"` - // Kubevirt contains settings specific to the kubevirt infrastructure provider. + // kubevirt contains settings specific to the kubevirt infrastructure provider. // +optional Kubevirt *KubevirtPlatformStatus `json:"kubevirt,omitempty"` - // EquinixMetal contains settings specific to the Equinix Metal infrastructure provider. + // equinixMetal contains settings specific to the Equinix Metal infrastructure provider. // +optional EquinixMetal *EquinixMetalPlatformStatus `json:"equinixMetal,omitempty"` - // PowerVS contains settings specific to the Power Systems Virtual Servers infrastructure provider. + // powervs contains settings specific to the Power Systems Virtual Servers infrastructure provider. // +optional PowerVS *PowerVSPlatformStatus `json:"powervs,omitempty"` - // AlibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. + // alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. // +optional AlibabaCloud *AlibabaCloudPlatformStatus `json:"alibabaCloud,omitempty"` - // Nutanix contains settings specific to the Nutanix infrastructure provider. + // nutanix contains settings specific to the Nutanix infrastructure provider. // +optional Nutanix *NutanixPlatformStatus `json:"nutanix,omitempty"` - // External contains settings specific to the generic External infrastructure provider. + // external contains settings specific to the generic External infrastructure provider. // +optional External *ExternalPlatformStatus `json:"external,omitempty"` } @@ -492,7 +491,7 @@ type AWSPlatformStatus struct { // region holds the default AWS region for new AWS resources created by the cluster. Region string `json:"region"` - // ServiceEndpoints list contains custom endpoints which will override default + // serviceEndpoints list contains custom endpoints which will override default // service endpoint of AWS Services. // There must be only one ServiceEndpoint for a service. // +listType=atomic @@ -526,7 +525,6 @@ type AWSPlatformStatus struct { // AWSResourceTag is a tag to apply to AWS resources created for the cluster. type AWSResourceTag struct { // key is the key of the tag - // +kubebuilder:validation:Required // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=128 // +kubebuilder:validation:Pattern=`^[0-9A-Za-z_.:/=+-@]+$` @@ -535,7 +533,6 @@ type AWSResourceTag struct { // value is the value of the tag. // 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. - // +kubebuilder:validation:Required // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=256 // +kubebuilder:validation:Pattern=`^[0-9A-Za-z_.:/=+-@]+$` @@ -584,14 +581,14 @@ type AzureResourceTag struct { // 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 `_ . -`. - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=128 // +kubebuilder:validation:Pattern=`^[a-zA-Z]([0-9A-Za-z_.-]*[0-9A-Za-z_])?$` Key string `json:"key"` // 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 `_ + , - . / : ; < = > ? @`. - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=256 // +kubebuilder:validation:Pattern=`^[0-9A-Za-z_.=+-@]+$` @@ -683,7 +680,7 @@ type GCPResourceLabel struct { // and the following special characters `_-`. Label key must not have the reserved prefixes `kubernetes-io` // and `openshift-io`. // +kubebuilder:validation:XValidation:rule="!self.startsWith('openshift-io') && !self.startsWith('kubernetes-io')",message="label keys must not start with either `openshift-io` or `kubernetes-io`" - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=63 // +kubebuilder:validation:Pattern=`^[a-z][0-9a-z_-]{0,62}$` @@ -691,7 +688,7 @@ type GCPResourceLabel struct { // 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 `_-`. - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=63 // +kubebuilder:validation:Pattern=`^[0-9a-z_-]{1,63}$` @@ -707,7 +704,7 @@ type GCPResourceTag struct { // 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. - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=32 // +kubebuilder:validation:Pattern=`(^[1-9][0-9]{0,31}$)|(^[a-z][a-z0-9-]{4,28}[a-z0-9]$)` @@ -716,7 +713,7 @@ type GCPResourceTag struct { // 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 `._-`. - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=63 // +kubebuilder:validation:Pattern=`^[a-zA-Z0-9]([0-9A-Za-z_.-]{0,61}[a-zA-Z0-9])?$` @@ -725,7 +722,7 @@ type GCPResourceTag struct { // 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. - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=63 // +kubebuilder:validation:Pattern=`^[a-zA-Z0-9]([0-9A-Za-z_.@%=+:,*#&()\[\]{}\-\s]{0,61}[a-zA-Z0-9])?$` @@ -1189,7 +1186,7 @@ const ( type VSpherePlatformFailureDomainSpec struct { // name defines the arbitrary but unique name // of a failure domain. - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=256 Name string `json:"name"` @@ -1199,7 +1196,7 @@ type VSpherePlatformFailureDomainSpec struct { // category in vCenter must be named openshift-region. // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=80 - // +kubebuilder:validation:Required + // +required Region string `json:"region"` // zone defines the name of a zone tag that will @@ -1207,7 +1204,7 @@ type VSpherePlatformFailureDomainSpec struct { // category in vCenter must be named openshift-zone. // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=80 - // +kubebuilder:validation:Required + // +required Zone string `json:"zone"` // regionAffinity holds the type of region, Datacenter or ComputeCluster. @@ -1226,15 +1223,15 @@ type VSpherePlatformFailureDomainSpec struct { ZoneAffinity *VSphereFailureDomainZoneAffinity `json:"zoneAffinity,omitempty"` // server is the fully-qualified domain name or the IP address of the vCenter server. - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=255 // --- // + Validation is applied via a patch, we validate the format as either ipv4, ipv6 or hostname Server string `json:"server"` - // Topology describes a given failure domain using vSphere constructs - // +kubebuilder:validation:Required + // topology describes a given failure domain using vSphere constructs + // +required Topology VSpherePlatformTopology `json:"topology"` } @@ -1243,7 +1240,7 @@ type VSpherePlatformFailureDomainSpec struct { type VSpherePlatformTopology struct { // datacenter is the name of vCenter datacenter in which virtual machines will be located. // The maximum length of the datacenter name is 80 characters. - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:MaxLength=80 Datacenter string `json:"datacenter"` @@ -1251,7 +1248,7 @@ type VSpherePlatformTopology struct { // in which virtual machine will be located. // The absolute path is of the form //host/. // The maximum length of the path is 2048 characters. - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:MaxLength=2048 // +kubebuilder:validation:Pattern=`^/.*?/host/.*?` ComputeCluster string `json:"computeCluster"` @@ -1264,7 +1261,7 @@ type VSpherePlatformTopology struct { // `govc ls 'network/*'` // Networks should be in the form of an absolute path: // //network/. - // +kubebuilder:validation:Required + // +required // +openshift:validation:FeatureGateAwareMaxItems:featureGate="",maxItems=1 // +openshift:validation:FeatureGateAwareMaxItems:featureGate=VSphereMultiNetworks,maxItems=10 // +kubebuilder:validation:MinItems=1 @@ -1275,7 +1272,7 @@ type VSpherePlatformTopology struct { // virtual machine is located. // The absolute path is of the form //datastore/ // The maximum length of the path is 2048 characters. - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:MaxLength=2048 // +kubebuilder:validation:Pattern=`^/.*?/datastore/.*?` Datastore string `json:"datastore"` @@ -1387,7 +1384,7 @@ type VSphereFailureDomainHostGroup struct { type VSpherePlatformVCenterSpec struct { // server is the fully-qualified domain name or the IP address of the vCenter server. - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:MaxLength=255 // --- // + Validation is applied via a patch, we validate the format as either ipv4, ipv6 or hostname @@ -1408,7 +1405,7 @@ type VSpherePlatformVCenterSpec struct { // be used by the Cloud Controller Manager. // Each datacenter listed here should be used within // a topology. - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:MinItems=1 // +listType=set Datacenters []string `json:"datacenters"` @@ -1609,14 +1606,14 @@ type IBMCloudServiceEndpoint struct { // 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` // - // +kubebuilder:validation:Required + // +required Name IBMCloudServiceName `json:"name"` // 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. // - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:Type=string // +kubebuilder:validation:XValidation:rule="isURL(self)",message="url must be a valid absolute URL" URL string `json:"url"` @@ -1628,20 +1625,20 @@ type IBMCloudPlatformSpec struct{} // IBMCloudPlatformStatus holds the current status of the IBMCloud infrastructure provider. type IBMCloudPlatformStatus struct { - // Location is where the cluster has been deployed + // location is where the cluster has been deployed Location string `json:"location,omitempty"` - // ResourceGroupName is the Resource Group for new IBMCloud resources created for the cluster. + // resourceGroupName is the Resource Group for new IBMCloud resources created for the cluster. ResourceGroupName string `json:"resourceGroupName,omitempty"` - // ProviderType indicates the type of cluster that was created + // providerType indicates the type of cluster that was created ProviderType IBMCloudProviderType `json:"providerType,omitempty"` - // CISInstanceCRN is the CRN of the Cloud Internet Services instance managing + // cisInstanceCRN is the CRN of the Cloud Internet Services instance managing // the DNS zone for the cluster's base domain CISInstanceCRN string `json:"cisInstanceCRN,omitempty"` - // DNSInstanceCRN is the CRN of the DNS Services instance managing the DNS zone + // dnsInstanceCRN is the CRN of the DNS Services instance managing the DNS zone // for the cluster's base domain DNSInstanceCRN string `json:"dnsInstanceCRN,omitempty"` @@ -1697,7 +1694,7 @@ type PowerVSServiceEndpoint struct { // ResourceController - https://cloud.ibm.com/apidocs/resource-controller/resource-controller // Power Cloud - https://cloud.ibm.com/apidocs/power-cloud // - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:Enum=CIS;COS;COSConfig;DNSServices;GlobalCatalog;GlobalSearch;GlobalTagging;HyperProtect;IAM;KeyProtect;Power;ResourceController;ResourceManager;VPC Name string `json:"name"` @@ -1705,7 +1702,7 @@ type PowerVSServiceEndpoint struct { // endpoint for a client. // This must be provided and cannot be empty. // - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:Type=string // +kubebuilder:validation:Format=uri // +kubebuilder:validation:Pattern=`^https://` @@ -1752,11 +1749,11 @@ type PowerVSPlatformStatus struct { // +optional ServiceEndpoints []PowerVSServiceEndpoint `json:"serviceEndpoints,omitempty"` - // CISInstanceCRN is the CRN of the Cloud Internet Services instance managing + // cisInstanceCRN is the CRN of the Cloud Internet Services instance managing // the DNS zone for the cluster's base domain CISInstanceCRN string `json:"cisInstanceCRN,omitempty"` - // DNSInstanceCRN is the CRN of the DNS Services instance managing the DNS zone + // dnsInstanceCRN is the CRN of the DNS Services instance managing the DNS zone // for the cluster's base domain DNSInstanceCRN string `json:"dnsInstanceCRN,omitempty"` } @@ -1768,7 +1765,6 @@ type AlibabaCloudPlatformSpec struct{} // AlibabaCloudPlatformStatus holds the current status of the Alibaba Cloud infrastructure provider. type AlibabaCloudPlatformStatus struct { // region specifies the region for Alibaba Cloud resources created for the cluster. - // +kubebuilder:validation:Required // +kubebuilder:validation:Pattern=`^[0-9A-Za-z-]+$` // +required Region string `json:"region"` @@ -1787,13 +1783,11 @@ type AlibabaCloudPlatformStatus struct { // AlibabaCloudResourceTag is the set of tags to add to apply to resources. type AlibabaCloudResourceTag struct { // key is the key of the tag. - // +kubebuilder:validation:Required // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=128 // +required Key string `json:"key"` // value is the value of the tag. - // +kubebuilder:validation:Required // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=128 // +required @@ -1828,7 +1822,7 @@ type NutanixPlatformSpec struct { // 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. - // +kubebuilder:validation:Required + // +required PrismCentral NutanixPrismEndpoint `json:"prismCentral"` // prismElements holds one or more endpoint address and port data to access the Nutanix @@ -1836,7 +1830,7 @@ type NutanixPlatformSpec struct { // 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. - // +kubebuilder:validation:Required + // +required // +listType=map // +listMapKey=name PrismElements []NutanixPrismElementEndpoint `json:"prismElements"` @@ -1858,7 +1852,7 @@ type NutanixFailureDomain struct { // 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. - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=64 // +kubebuilder:validation:Pattern=`[a-z0-9]([-a-z0-9]*[a-z0-9])?` @@ -1867,14 +1861,14 @@ type NutanixFailureDomain struct { // 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. - // +kubebuilder:validation:Required + // +required Cluster NutanixResourceIdentifier `json:"cluster"` // 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. - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:MinItems=1 // +openshift:validation:FeatureGateAwareMaxItems:featureGate="",maxItems=1 // +openshift:validation:FeatureGateAwareMaxItems:featureGate=NutanixMultiSubnets,maxItems=32 @@ -1902,7 +1896,7 @@ const ( type NutanixResourceIdentifier struct { // type is the identifier type to use for this resource. // +unionDiscriminator - // +kubebuilder:validation:Required + // +required Type NutanixIdentifierType `json:"type"` // uuid is the UUID of the resource in the PC. It cannot be empty if the type is UUID. @@ -1917,12 +1911,12 @@ type NutanixResourceIdentifier struct { // NutanixPrismEndpoint holds the endpoint address and port to access the Nutanix Prism Central or Element (cluster) type NutanixPrismEndpoint struct { // address is the endpoint address (DNS name or IP address) of the Nutanix Prism Central or Element (cluster) - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:MaxLength=256 Address string `json:"address"` // port is the port number to access the Nutanix Prism Central or Element (cluster) - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:Minimum=1 // +kubebuilder:validation:Maximum=65535 Port int32 `json:"port"` @@ -1932,7 +1926,7 @@ type NutanixPrismEndpoint struct { type NutanixPrismElementEndpoint struct { // 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). - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:MaxLength=256 Name string `json:"name"` @@ -1940,7 +1934,7 @@ type NutanixPrismElementEndpoint struct { // 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. - // +kubebuilder:validation:Required + // +required Endpoint NutanixPrismEndpoint `json:"endpoint"` } diff --git a/config/v1/types_ingress.go b/config/v1/types_ingress.go index 302913a16f9..9492e08a72c 100644 --- a/config/v1/types_ingress.go +++ b/config/v1/types_ingress.go @@ -27,7 +27,6 @@ type Ingress struct { metav1.ObjectMeta `json:"metadata,omitempty"` // spec holds user settable values for configuration - // +kubebuilder:validation:Required // +required Spec IngressSpec `json:"spec"` // status holds observed values from the cluster. They may not be overridden. @@ -150,7 +149,7 @@ type AWSIngressSpec struct { // https://docs.aws.amazon.com/AmazonECS/latest/developerguide/load-balancer-types.html#nlb // +unionDiscriminator // +kubebuilder:validation:Enum:=NLB;Classic - // +kubebuilder:validation:Required + // +required Type AWSLBType `json:"type,omitempty"` } @@ -223,7 +222,6 @@ type ComponentRouteSpec struct { // +kubebuilder:validation:Pattern=^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=63 - // +kubebuilder:validation:Required // +required Namespace string `json:"namespace"` @@ -233,12 +231,10 @@ type ComponentRouteSpec struct { // entry in the list of status.componentRoutes if the route is to be customized. // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=256 - // +kubebuilder:validation:Required // +required Name string `json:"name"` // hostname is the hostname that should be used by the route. - // +kubebuilder:validation:Required // +required Hostname Hostname `json:"hostname"` @@ -260,7 +256,6 @@ type ComponentRouteStatus struct { // +kubebuilder:validation:Pattern=^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=63 - // +kubebuilder:validation:Required // +required Namespace string `json:"namespace"` @@ -271,12 +266,10 @@ type ComponentRouteStatus struct { // entry in the list of spec.componentRoutes if the route is to be customized. // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=256 - // +kubebuilder:validation:Required // +required Name string `json:"name"` // defaultHostname is the hostname of this route prior to customization. - // +kubebuilder:validation:Required // +required DefaultHostname Hostname `json:"defaultHostname"` @@ -310,7 +303,6 @@ type ComponentRouteStatus struct { // relatedObjects is a list of resources which are useful when debugging or inspecting how spec.componentRoutes is applied. // +kubebuilder:validation:MinItems=1 - // +kubebuilder:validation:Required // +required RelatedObjects []ObjectReference `json:"relatedObjects"` } diff --git a/config/v1/types_network.go b/config/v1/types_network.go index 1eeae69dac9..70e87bcfa48 100644 --- a/config/v1/types_network.go +++ b/config/v1/types_network.go @@ -30,7 +30,6 @@ type Network struct { // 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. - // +kubebuilder:validation:Required // +required Spec NetworkSpec `json:"spec"` // status holds observed values from the cluster. They may not be overridden. @@ -55,7 +54,7 @@ type NetworkSpec struct { // +listType=atomic ServiceNetwork []string `json:"serviceNetwork"` - // NetworkType is the plugin that is to be deployed (e.g. OVNKubernetes). + // 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: @@ -101,13 +100,13 @@ type NetworkStatus struct { // +listType=atomic ServiceNetwork []string `json:"serviceNetwork,omitempty"` - // NetworkType is the plugin that is deployed (e.g. OVNKubernetes). + // networkType is the plugin that is deployed (e.g. OVNKubernetes). NetworkType string `json:"networkType,omitempty"` - // ClusterNetworkMTU is the MTU for inter-pod networking. + // clusterNetworkMTU is the MTU for inter-pod networking. ClusterNetworkMTU int `json:"clusterNetworkMTU,omitempty"` - // Migration contains the cluster network migration configuration. + // migration contains the cluster network migration configuration. Migration *NetworkMigration `json:"migration,omitempty"` // conditions represents the observations of a network.config current state. @@ -185,24 +184,24 @@ type NetworkList struct { // NetworkMigration represents the network migration status. type NetworkMigration struct { - // NetworkType is the target plugin that is being deployed. + // networkType is the target plugin that is being deployed. // DEPRECATED: network type migration is no longer supported, // so this should always be unset. // +optional NetworkType string `json:"networkType,omitempty"` - // MTU is the MTU configuration that is being deployed. + // mtu is the MTU configuration that is being deployed. // +optional MTU *MTUMigration `json:"mtu,omitempty"` } // MTUMigration contains infomation about MTU migration. type MTUMigration struct { - // Network contains MTU migration configuration for the default network. + // network contains MTU migration configuration for the default network. // +optional Network *MTUMigrationValues `json:"network,omitempty"` - // Machine contains MTU migration configuration for the machine's uplink. + // machine contains MTU migration configuration for the machine's uplink. // +optional Machine *MTUMigrationValues `json:"machine,omitempty"` } diff --git a/config/v1/types_node.go b/config/v1/types_node.go index a50328c91f6..3fc7bc0c39a 100644 --- a/config/v1/types_node.go +++ b/config/v1/types_node.go @@ -28,7 +28,6 @@ type Node struct { metav1.ObjectMeta `json:"metadata,omitempty"` // spec holds user settable values for configuration - // +kubebuilder:validation:Required // +required Spec NodeSpec `json:"spec"` @@ -38,11 +37,11 @@ type Node struct { } type NodeSpec struct { - // CgroupMode determines the cgroups version on the node + // cgroupMode determines the cgroups version on the node // +optional CgroupMode CgroupMode `json:"cgroupMode,omitempty"` - // WorkerLatencyProfile determins the how fast the kubelet is updating + // workerLatencyProfile determins the how fast the kubelet is updating // the status and corresponding reaction of the cluster // +optional WorkerLatencyProfile WorkerLatencyProfileType `json:"workerLatencyProfile,omitempty"` diff --git a/config/v1/types_oauth.go b/config/v1/types_oauth.go index dce08a17f54..20845e4dbe9 100644 --- a/config/v1/types_oauth.go +++ b/config/v1/types_oauth.go @@ -27,7 +27,6 @@ type OAuth struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata"` // spec holds user settable values for configuration - // +kubebuilder:validation:Required // +required Spec OAuthSpec `json:"spec"` // status holds observed values from the cluster. They may not be overridden. diff --git a/config/v1/types_project.go b/config/v1/types_project.go index 78fd3f41a0d..3d219862be3 100644 --- a/config/v1/types_project.go +++ b/config/v1/types_project.go @@ -24,7 +24,6 @@ type Project struct { metav1.ObjectMeta `json:"metadata,omitempty"` // spec holds user settable values for configuration - // +kubebuilder:validation:Required // +required Spec ProjectSpec `json:"spec"` // status holds observed values from the cluster. They may not be overridden. diff --git a/config/v1/types_proxy.go b/config/v1/types_proxy.go index 2dfc66b1cdc..ed40176ce36 100644 --- a/config/v1/types_proxy.go +++ b/config/v1/types_proxy.go @@ -25,8 +25,7 @@ type Proxy struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata,omitempty"` - // Spec holds user-settable values for the proxy configuration - // +kubebuilder:validation:Required + // spec holds user-settable values for the proxy configuration // +required Spec ProxySpec `json:"spec"` // status holds observed values from the cluster. They may not be overridden. diff --git a/config/v1/types_scheduling.go b/config/v1/types_scheduling.go index 2749f4f70d8..c90d5633f68 100644 --- a/config/v1/types_scheduling.go +++ b/config/v1/types_scheduling.go @@ -25,7 +25,6 @@ type Scheduler struct { metav1.ObjectMeta `json:"metadata,omitempty"` // spec holds user settable values for configuration - // +kubebuilder:validation:Required // +required Spec SchedulerSpec `json:"spec"` // status holds observed values from the cluster. They may not be overridden. @@ -74,7 +73,7 @@ type SchedulerSpec struct { // would not be applied. // +optional DefaultNodeSelector string `json:"defaultNodeSelector,omitempty"` - // MastersSchedulable allows masters nodes to be schedulable. When this flag is + // 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. diff --git a/config/v1/types_testreporting.go b/config/v1/types_testreporting.go index 4d642e060b5..00953957f49 100644 --- a/config/v1/types_testreporting.go +++ b/config/v1/types_testreporting.go @@ -15,7 +15,6 @@ type TestReporting struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata,omitempty"` - // +kubebuilder:validation:Required // +required Spec TestReportingSpec `json:"spec"` // status holds observed values from the cluster. They may not be overridden. @@ -24,20 +23,20 @@ type TestReporting struct { } type TestReportingSpec struct { - // TestsForFeatureGates is a list, indexed by FeatureGate and includes information about testing. + // testsForFeatureGates is a list, indexed by FeatureGate and includes information about testing. TestsForFeatureGates []FeatureGateTests `json:"testsForFeatureGates"` } type FeatureGateTests struct { - // FeatureGate is the name of the FeatureGate as it appears in The FeatureGate CR instance. + // featureGate is the name of the FeatureGate as it appears in The FeatureGate CR instance. FeatureGate string `json:"featureGate"` - // Tests contains an item for every TestName + // tests contains an item for every TestName Tests []TestDetails `json:"tests"` } type TestDetails struct { - // TestName is the name of the test as it appears in junit XMLs. + // 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. TestName string `json:"testName"` } diff --git a/config/v1/zz_generated.crd-manifests/0000_00_cluster-version-operator_01_clusterversions-CustomNoUpgrade.crd.yaml b/config/v1/zz_generated.crd-manifests/0000_00_cluster-version-operator_01_clusterversions-CustomNoUpgrade.crd.yaml index 0367b10d2f2..5061a69c6f7 100644 --- a/config/v1/zz_generated.crd-manifests/0000_00_cluster-version-operator_01_clusterversions-CustomNoUpgrade.crd.yaml +++ b/config/v1/zz_generated.crd-manifests/0000_00_cluster-version-operator_01_clusterversions-CustomNoUpgrade.crd.yaml @@ -194,10 +194,10 @@ spec: x-kubernetes-validations: - message: cannot set both Architecture and Image rule: 'has(self.architecture) && has(self.image) ? (self.architecture - == '''' || self.image == '''') : true' + == "" || self.image == "") : true' - message: Version must be set if Architecture is set - rule: 'has(self.architecture) && self.architecture != '''' ? self.version - != '''' : true' + rule: 'has(self.architecture) && self.architecture != "" ? self.version + != "" : true' overrides: description: |- overrides is list of overides for components that are managed by @@ -574,12 +574,12 @@ spec: fail to evaluate. properties: promql: - description: promQL represents a cluster condition + description: promql represents a cluster condition based on PromQL. properties: promql: description: |- - PromQL is a PromQL query classifying clusters. This query + 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 diff --git a/config/v1/zz_generated.crd-manifests/0000_00_cluster-version-operator_01_clusterversions-Default.crd.yaml b/config/v1/zz_generated.crd-manifests/0000_00_cluster-version-operator_01_clusterversions-Default.crd.yaml index 92e44d6f7fb..caeeb9064a6 100644 --- a/config/v1/zz_generated.crd-manifests/0000_00_cluster-version-operator_01_clusterversions-Default.crd.yaml +++ b/config/v1/zz_generated.crd-manifests/0000_00_cluster-version-operator_01_clusterversions-Default.crd.yaml @@ -194,10 +194,10 @@ spec: x-kubernetes-validations: - message: cannot set both Architecture and Image rule: 'has(self.architecture) && has(self.image) ? (self.architecture - == '''' || self.image == '''') : true' + == "" || self.image == "") : true' - message: Version must be set if Architecture is set - rule: 'has(self.architecture) && self.architecture != '''' ? self.version - != '''' : true' + rule: 'has(self.architecture) && self.architecture != "" ? self.version + != "" : true' overrides: description: |- overrides is list of overides for components that are managed by @@ -501,12 +501,12 @@ spec: fail to evaluate. properties: promql: - description: promQL represents a cluster condition + description: promql represents a cluster condition based on PromQL. properties: promql: description: |- - PromQL is a PromQL query classifying clusters. This query + 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 diff --git a/config/v1/zz_generated.crd-manifests/0000_00_cluster-version-operator_01_clusterversions-DevPreviewNoUpgrade.crd.yaml b/config/v1/zz_generated.crd-manifests/0000_00_cluster-version-operator_01_clusterversions-DevPreviewNoUpgrade.crd.yaml index b6bf0bac2c5..d7319febe0b 100644 --- a/config/v1/zz_generated.crd-manifests/0000_00_cluster-version-operator_01_clusterversions-DevPreviewNoUpgrade.crd.yaml +++ b/config/v1/zz_generated.crd-manifests/0000_00_cluster-version-operator_01_clusterversions-DevPreviewNoUpgrade.crd.yaml @@ -194,10 +194,10 @@ spec: x-kubernetes-validations: - message: cannot set both Architecture and Image rule: 'has(self.architecture) && has(self.image) ? (self.architecture - == '''' || self.image == '''') : true' + == "" || self.image == "") : true' - message: Version must be set if Architecture is set - rule: 'has(self.architecture) && self.architecture != '''' ? self.version - != '''' : true' + rule: 'has(self.architecture) && self.architecture != "" ? self.version + != "" : true' overrides: description: |- overrides is list of overides for components that are managed by @@ -574,12 +574,12 @@ spec: fail to evaluate. properties: promql: - description: promQL represents a cluster condition + description: promql represents a cluster condition based on PromQL. properties: promql: description: |- - PromQL is a PromQL query classifying clusters. This query + 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 diff --git a/config/v1/zz_generated.crd-manifests/0000_00_cluster-version-operator_01_clusterversions-TechPreviewNoUpgrade.crd.yaml b/config/v1/zz_generated.crd-manifests/0000_00_cluster-version-operator_01_clusterversions-TechPreviewNoUpgrade.crd.yaml index 53151925f1f..4380248875b 100644 --- a/config/v1/zz_generated.crd-manifests/0000_00_cluster-version-operator_01_clusterversions-TechPreviewNoUpgrade.crd.yaml +++ b/config/v1/zz_generated.crd-manifests/0000_00_cluster-version-operator_01_clusterversions-TechPreviewNoUpgrade.crd.yaml @@ -194,10 +194,10 @@ spec: x-kubernetes-validations: - message: cannot set both Architecture and Image rule: 'has(self.architecture) && has(self.image) ? (self.architecture - == '''' || self.image == '''') : true' + == "" || self.image == "") : true' - message: Version must be set if Architecture is set - rule: 'has(self.architecture) && self.architecture != '''' ? self.version - != '''' : true' + rule: 'has(self.architecture) && self.architecture != "" ? self.version + != "" : true' overrides: description: |- overrides is list of overides for components that are managed by @@ -574,12 +574,12 @@ spec: fail to evaluate. properties: promql: - description: promQL represents a cluster condition + description: promql represents a cluster condition based on PromQL. properties: promql: description: |- - PromQL is a PromQL query classifying clusters. This query + 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 diff --git a/config/v1/zz_generated.crd-manifests/0000_03_config-operator_01_proxies.crd.yaml b/config/v1/zz_generated.crd-manifests/0000_03_config-operator_01_proxies.crd.yaml index b774262cd02..99ea9d49cca 100644 --- a/config/v1/zz_generated.crd-manifests/0000_03_config-operator_01_proxies.crd.yaml +++ b/config/v1/zz_generated.crd-manifests/0000_03_config-operator_01_proxies.crd.yaml @@ -43,7 +43,7 @@ spec: metadata: type: object spec: - description: Spec holds user-settable values for the proxy configuration + description: spec holds user-settable values for the proxy configuration properties: httpProxy: description: httpProxy is the URL of the proxy for HTTP requests. Empty diff --git a/config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_authentications-Hypershift.crd.yaml b/config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_authentications-Hypershift.crd.yaml index 8f7dc33442c..93b2b00626a 100644 --- a/config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_authentications-Hypershift.crd.yaml +++ b/config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_authentications-Hypershift.crd.yaml @@ -69,7 +69,7 @@ spec: type: object oidcProviders: description: |- - OIDCProviders are OIDC identity providers that can issue tokens + oidcProviders are OIDC identity providers that can issue tokens for this cluster Can only be set if "Type" is set to "OIDC". @@ -78,22 +78,22 @@ spec: properties: claimMappings: description: |- - ClaimMappings describes rules on how to transform information from an + claimMappings describes rules on how to transform information from an ID token into a cluster identity properties: groups: description: |- - Groups is a name of the claim that should be used to construct + groups is a name of the claim that should be used to construct groups for the cluster identity. The referenced claim must use array of strings values. properties: claim: - description: Claim is a JWT token claim to be used in + description: claim is a JWT token claim to be used in the mapping type: string prefix: description: |- - Prefix is a string to prefix the value from the token in the result of the + prefix is a string to prefix the value from the token in the result of the claim mapping. By default, no prefixing occurs. @@ -107,13 +107,13 @@ spec: type: object username: description: |- - Username is a name of the claim that should be used to construct + username is a name of the claim that should be used to construct usernames for the cluster identity. Default value: "sub" properties: claim: - description: Claim is a JWT token claim to be used in + description: claim is a JWT token claim to be used in the mapping type: string prefix: @@ -126,7 +126,7 @@ spec: type: object prefixPolicy: description: |- - PrefixPolicy specifies how a prefix should apply. + prefixPolicy specifies how a prefix should apply. By default, claims other than `email` will be prefixed with the issuer URL to prevent naming clashes with other plugins. @@ -161,23 +161,23 @@ spec: > 0) : !has(self.prefix)' type: object claimValidationRules: - description: ClaimValidationRules are rules that are applied + description: claimValidationRules are rules that are applied to validate token claims to authenticate users. items: properties: requiredClaim: description: |- - RequiredClaim allows configuring a required claim name and its expected + requiredClaim allows configuring a required claim name and its expected value properties: claim: description: |- - Claim is a name of a required claim. Only claims with string values are + claim is a name of a required claim. Only claims with string values are supported. minLength: 1 type: string requiredValue: - description: RequiredValue is the required value for + description: requiredValue is the required value for the claim. minLength: 1 type: string @@ -187,7 +187,7 @@ spec: type: object type: default: RequiredClaim - description: Type sets the type of the validation rule + description: type sets the type of the validation rule enum: - RequiredClaim type: string @@ -195,11 +195,11 @@ spec: type: array x-kubernetes-list-type: atomic issuer: - description: Issuer describes atributes of the OIDC token issuer + description: issuer describes atributes of the OIDC token issuer properties: audiences: description: |- - Audiences is an array of audiences that the token was issued for. + audiences is an array of audiences that the token was issued for. Valid tokens must include at least one of these values in their "aud" claim. Must be set to exactly one value. @@ -235,23 +235,23 @@ spec: - issuerURL type: object name: - description: Name of the OIDC provider + description: name of the OIDC provider minLength: 1 type: string oidcClients: description: |- - OIDCClients contains configuration for the platform's clients that + oidcClients contains configuration for the platform's clients that need to request tokens from the issuer items: properties: clientID: - description: ClientID is the identifier of the OIDC client + description: clientID is the identifier of the OIDC client from the OIDC provider minLength: 1 type: string clientSecret: description: |- - ClientSecret refers to a secret in the `openshift-config` namespace that + clientSecret refers to a secret in the `openshift-config` namespace that contains the client secret in the `clientSecret` key of the `.data` field properties: name: @@ -263,20 +263,20 @@ spec: type: object componentName: description: |- - ComponentName is the name of the component that is supposed to consume this + componentName is the name of the component that is supposed to consume this client configuration maxLength: 256 minLength: 1 type: string componentNamespace: description: |- - ComponentNamespace is the namespace of the component that is supposed to consume this + componentNamespace is the namespace of the component that is supposed to consume this client configuration maxLength: 63 minLength: 1 type: string extraScopes: - description: ExtraScopes is an optional set of scopes + description: extraScopes is an optional set of scopes to request tokens with. items: type: string @@ -414,25 +414,25 @@ spec: type: object oidcClients: description: |- - OIDCClients is where participating operators place the current OIDC client status + oidcClients is where participating operators place the current OIDC client status for OIDC clients that can be customized by the cluster-admin. items: properties: componentName: - description: ComponentName is the name of the component that + description: componentName is the name of the component that will consume a client configuration. maxLength: 256 minLength: 1 type: string componentNamespace: - description: ComponentNamespace is the namespace of the component + description: componentNamespace is the namespace of the component that will consume a client configuration. maxLength: 63 minLength: 1 type: string conditions: description: |- - Conditions are used to communicate the state of the `oidcClients` entry. + conditions are used to communicate the state of the `oidcClients` entry. Supported conditions include Available, Degraded and Progressing. @@ -500,7 +500,7 @@ spec: x-kubernetes-list-type: map consumingUsers: description: |- - ConsumingUsers is a slice of ServiceAccounts that need to have read + consumingUsers is a slice of ServiceAccounts that need to have read permission on the `clientSecret` secret. items: description: ConsumingUser is an alias for string which we @@ -513,12 +513,12 @@ spec: type: array x-kubernetes-list-type: set currentOIDCClients: - description: CurrentOIDCClients is a list of clients that the + description: currentOIDCClients is a list of clients that the component is currently using. items: properties: clientID: - description: ClientID is the identifier of the OIDC client + description: clientID is the identifier of the OIDC client from the OIDC provider minLength: 1 type: string diff --git a/config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_authentications-SelfManagedHA-CustomNoUpgrade.crd.yaml b/config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_authentications-SelfManagedHA-CustomNoUpgrade.crd.yaml index 9d7058b463a..07c2f49d234 100644 --- a/config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_authentications-SelfManagedHA-CustomNoUpgrade.crd.yaml +++ b/config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_authentications-SelfManagedHA-CustomNoUpgrade.crd.yaml @@ -70,7 +70,7 @@ spec: type: object oidcProviders: description: |- - OIDCProviders are OIDC identity providers that can issue tokens + oidcProviders are OIDC identity providers that can issue tokens for this cluster Can only be set if "Type" is set to "OIDC". @@ -79,22 +79,22 @@ spec: properties: claimMappings: description: |- - ClaimMappings describes rules on how to transform information from an + claimMappings describes rules on how to transform information from an ID token into a cluster identity properties: groups: description: |- - Groups is a name of the claim that should be used to construct + groups is a name of the claim that should be used to construct groups for the cluster identity. The referenced claim must use array of strings values. properties: claim: - description: Claim is a JWT token claim to be used in + description: claim is a JWT token claim to be used in the mapping type: string prefix: description: |- - Prefix is a string to prefix the value from the token in the result of the + prefix is a string to prefix the value from the token in the result of the claim mapping. By default, no prefixing occurs. @@ -108,13 +108,13 @@ spec: type: object username: description: |- - Username is a name of the claim that should be used to construct + username is a name of the claim that should be used to construct usernames for the cluster identity. Default value: "sub" properties: claim: - description: Claim is a JWT token claim to be used in + description: claim is a JWT token claim to be used in the mapping type: string prefix: @@ -127,7 +127,7 @@ spec: type: object prefixPolicy: description: |- - PrefixPolicy specifies how a prefix should apply. + prefixPolicy specifies how a prefix should apply. By default, claims other than `email` will be prefixed with the issuer URL to prevent naming clashes with other plugins. @@ -162,23 +162,23 @@ spec: > 0) : !has(self.prefix)' type: object claimValidationRules: - description: ClaimValidationRules are rules that are applied + description: claimValidationRules are rules that are applied to validate token claims to authenticate users. items: properties: requiredClaim: description: |- - RequiredClaim allows configuring a required claim name and its expected + requiredClaim allows configuring a required claim name and its expected value properties: claim: description: |- - Claim is a name of a required claim. Only claims with string values are + claim is a name of a required claim. Only claims with string values are supported. minLength: 1 type: string requiredValue: - description: RequiredValue is the required value for + description: requiredValue is the required value for the claim. minLength: 1 type: string @@ -188,7 +188,7 @@ spec: type: object type: default: RequiredClaim - description: Type sets the type of the validation rule + description: type sets the type of the validation rule enum: - RequiredClaim type: string @@ -196,11 +196,11 @@ spec: type: array x-kubernetes-list-type: atomic issuer: - description: Issuer describes atributes of the OIDC token issuer + description: issuer describes atributes of the OIDC token issuer properties: audiences: description: |- - Audiences is an array of audiences that the token was issued for. + audiences is an array of audiences that the token was issued for. Valid tokens must include at least one of these values in their "aud" claim. Must be set to exactly one value. @@ -236,23 +236,23 @@ spec: - issuerURL type: object name: - description: Name of the OIDC provider + description: name of the OIDC provider minLength: 1 type: string oidcClients: description: |- - OIDCClients contains configuration for the platform's clients that + oidcClients contains configuration for the platform's clients that need to request tokens from the issuer items: properties: clientID: - description: ClientID is the identifier of the OIDC client + description: clientID is the identifier of the OIDC client from the OIDC provider minLength: 1 type: string clientSecret: description: |- - ClientSecret refers to a secret in the `openshift-config` namespace that + clientSecret refers to a secret in the `openshift-config` namespace that contains the client secret in the `clientSecret` key of the `.data` field properties: name: @@ -264,20 +264,20 @@ spec: type: object componentName: description: |- - ComponentName is the name of the component that is supposed to consume this + componentName is the name of the component that is supposed to consume this client configuration maxLength: 256 minLength: 1 type: string componentNamespace: description: |- - ComponentNamespace is the namespace of the component that is supposed to consume this + componentNamespace is the namespace of the component that is supposed to consume this client configuration maxLength: 63 minLength: 1 type: string extraScopes: - description: ExtraScopes is an optional set of scopes + description: extraScopes is an optional set of scopes to request tokens with. items: type: string @@ -415,25 +415,25 @@ spec: type: object oidcClients: description: |- - OIDCClients is where participating operators place the current OIDC client status + oidcClients is where participating operators place the current OIDC client status for OIDC clients that can be customized by the cluster-admin. items: properties: componentName: - description: ComponentName is the name of the component that + description: componentName is the name of the component that will consume a client configuration. maxLength: 256 minLength: 1 type: string componentNamespace: - description: ComponentNamespace is the namespace of the component + description: componentNamespace is the namespace of the component that will consume a client configuration. maxLength: 63 minLength: 1 type: string conditions: description: |- - Conditions are used to communicate the state of the `oidcClients` entry. + conditions are used to communicate the state of the `oidcClients` entry. Supported conditions include Available, Degraded and Progressing. @@ -501,7 +501,7 @@ spec: x-kubernetes-list-type: map consumingUsers: description: |- - ConsumingUsers is a slice of ServiceAccounts that need to have read + consumingUsers is a slice of ServiceAccounts that need to have read permission on the `clientSecret` secret. items: description: ConsumingUser is an alias for string which we @@ -514,12 +514,12 @@ spec: type: array x-kubernetes-list-type: set currentOIDCClients: - description: CurrentOIDCClients is a list of clients that the + description: currentOIDCClients is a list of clients that the component is currently using. items: properties: clientID: - description: ClientID is the identifier of the OIDC client + description: clientID is the identifier of the OIDC client from the OIDC provider minLength: 1 type: string diff --git a/config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_authentications-SelfManagedHA-DevPreviewNoUpgrade.crd.yaml b/config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_authentications-SelfManagedHA-DevPreviewNoUpgrade.crd.yaml index b2968832e3c..718aeff5d10 100644 --- a/config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_authentications-SelfManagedHA-DevPreviewNoUpgrade.crd.yaml +++ b/config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_authentications-SelfManagedHA-DevPreviewNoUpgrade.crd.yaml @@ -70,7 +70,7 @@ spec: type: object oidcProviders: description: |- - OIDCProviders are OIDC identity providers that can issue tokens + oidcProviders are OIDC identity providers that can issue tokens for this cluster Can only be set if "Type" is set to "OIDC". @@ -79,22 +79,22 @@ spec: properties: claimMappings: description: |- - ClaimMappings describes rules on how to transform information from an + claimMappings describes rules on how to transform information from an ID token into a cluster identity properties: groups: description: |- - Groups is a name of the claim that should be used to construct + groups is a name of the claim that should be used to construct groups for the cluster identity. The referenced claim must use array of strings values. properties: claim: - description: Claim is a JWT token claim to be used in + description: claim is a JWT token claim to be used in the mapping type: string prefix: description: |- - Prefix is a string to prefix the value from the token in the result of the + prefix is a string to prefix the value from the token in the result of the claim mapping. By default, no prefixing occurs. @@ -108,13 +108,13 @@ spec: type: object username: description: |- - Username is a name of the claim that should be used to construct + username is a name of the claim that should be used to construct usernames for the cluster identity. Default value: "sub" properties: claim: - description: Claim is a JWT token claim to be used in + description: claim is a JWT token claim to be used in the mapping type: string prefix: @@ -127,7 +127,7 @@ spec: type: object prefixPolicy: description: |- - PrefixPolicy specifies how a prefix should apply. + prefixPolicy specifies how a prefix should apply. By default, claims other than `email` will be prefixed with the issuer URL to prevent naming clashes with other plugins. @@ -162,23 +162,23 @@ spec: > 0) : !has(self.prefix)' type: object claimValidationRules: - description: ClaimValidationRules are rules that are applied + description: claimValidationRules are rules that are applied to validate token claims to authenticate users. items: properties: requiredClaim: description: |- - RequiredClaim allows configuring a required claim name and its expected + requiredClaim allows configuring a required claim name and its expected value properties: claim: description: |- - Claim is a name of a required claim. Only claims with string values are + claim is a name of a required claim. Only claims with string values are supported. minLength: 1 type: string requiredValue: - description: RequiredValue is the required value for + description: requiredValue is the required value for the claim. minLength: 1 type: string @@ -188,7 +188,7 @@ spec: type: object type: default: RequiredClaim - description: Type sets the type of the validation rule + description: type sets the type of the validation rule enum: - RequiredClaim type: string @@ -196,11 +196,11 @@ spec: type: array x-kubernetes-list-type: atomic issuer: - description: Issuer describes atributes of the OIDC token issuer + description: issuer describes atributes of the OIDC token issuer properties: audiences: description: |- - Audiences is an array of audiences that the token was issued for. + audiences is an array of audiences that the token was issued for. Valid tokens must include at least one of these values in their "aud" claim. Must be set to exactly one value. @@ -236,23 +236,23 @@ spec: - issuerURL type: object name: - description: Name of the OIDC provider + description: name of the OIDC provider minLength: 1 type: string oidcClients: description: |- - OIDCClients contains configuration for the platform's clients that + oidcClients contains configuration for the platform's clients that need to request tokens from the issuer items: properties: clientID: - description: ClientID is the identifier of the OIDC client + description: clientID is the identifier of the OIDC client from the OIDC provider minLength: 1 type: string clientSecret: description: |- - ClientSecret refers to a secret in the `openshift-config` namespace that + clientSecret refers to a secret in the `openshift-config` namespace that contains the client secret in the `clientSecret` key of the `.data` field properties: name: @@ -264,20 +264,20 @@ spec: type: object componentName: description: |- - ComponentName is the name of the component that is supposed to consume this + componentName is the name of the component that is supposed to consume this client configuration maxLength: 256 minLength: 1 type: string componentNamespace: description: |- - ComponentNamespace is the namespace of the component that is supposed to consume this + componentNamespace is the namespace of the component that is supposed to consume this client configuration maxLength: 63 minLength: 1 type: string extraScopes: - description: ExtraScopes is an optional set of scopes + description: extraScopes is an optional set of scopes to request tokens with. items: type: string @@ -415,25 +415,25 @@ spec: type: object oidcClients: description: |- - OIDCClients is where participating operators place the current OIDC client status + oidcClients is where participating operators place the current OIDC client status for OIDC clients that can be customized by the cluster-admin. items: properties: componentName: - description: ComponentName is the name of the component that + description: componentName is the name of the component that will consume a client configuration. maxLength: 256 minLength: 1 type: string componentNamespace: - description: ComponentNamespace is the namespace of the component + description: componentNamespace is the namespace of the component that will consume a client configuration. maxLength: 63 minLength: 1 type: string conditions: description: |- - Conditions are used to communicate the state of the `oidcClients` entry. + conditions are used to communicate the state of the `oidcClients` entry. Supported conditions include Available, Degraded and Progressing. @@ -501,7 +501,7 @@ spec: x-kubernetes-list-type: map consumingUsers: description: |- - ConsumingUsers is a slice of ServiceAccounts that need to have read + consumingUsers is a slice of ServiceAccounts that need to have read permission on the `clientSecret` secret. items: description: ConsumingUser is an alias for string which we @@ -514,12 +514,12 @@ spec: type: array x-kubernetes-list-type: set currentOIDCClients: - description: CurrentOIDCClients is a list of clients that the + description: currentOIDCClients is a list of clients that the component is currently using. items: properties: clientID: - description: ClientID is the identifier of the OIDC client + description: clientID is the identifier of the OIDC client from the OIDC provider minLength: 1 type: string diff --git a/config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_authentications-SelfManagedHA-TechPreviewNoUpgrade.crd.yaml b/config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_authentications-SelfManagedHA-TechPreviewNoUpgrade.crd.yaml index bd450f3a7dd..875290968b7 100644 --- a/config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_authentications-SelfManagedHA-TechPreviewNoUpgrade.crd.yaml +++ b/config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_authentications-SelfManagedHA-TechPreviewNoUpgrade.crd.yaml @@ -70,7 +70,7 @@ spec: type: object oidcProviders: description: |- - OIDCProviders are OIDC identity providers that can issue tokens + oidcProviders are OIDC identity providers that can issue tokens for this cluster Can only be set if "Type" is set to "OIDC". @@ -79,22 +79,22 @@ spec: properties: claimMappings: description: |- - ClaimMappings describes rules on how to transform information from an + claimMappings describes rules on how to transform information from an ID token into a cluster identity properties: groups: description: |- - Groups is a name of the claim that should be used to construct + groups is a name of the claim that should be used to construct groups for the cluster identity. The referenced claim must use array of strings values. properties: claim: - description: Claim is a JWT token claim to be used in + description: claim is a JWT token claim to be used in the mapping type: string prefix: description: |- - Prefix is a string to prefix the value from the token in the result of the + prefix is a string to prefix the value from the token in the result of the claim mapping. By default, no prefixing occurs. @@ -108,13 +108,13 @@ spec: type: object username: description: |- - Username is a name of the claim that should be used to construct + username is a name of the claim that should be used to construct usernames for the cluster identity. Default value: "sub" properties: claim: - description: Claim is a JWT token claim to be used in + description: claim is a JWT token claim to be used in the mapping type: string prefix: @@ -127,7 +127,7 @@ spec: type: object prefixPolicy: description: |- - PrefixPolicy specifies how a prefix should apply. + prefixPolicy specifies how a prefix should apply. By default, claims other than `email` will be prefixed with the issuer URL to prevent naming clashes with other plugins. @@ -162,23 +162,23 @@ spec: > 0) : !has(self.prefix)' type: object claimValidationRules: - description: ClaimValidationRules are rules that are applied + description: claimValidationRules are rules that are applied to validate token claims to authenticate users. items: properties: requiredClaim: description: |- - RequiredClaim allows configuring a required claim name and its expected + requiredClaim allows configuring a required claim name and its expected value properties: claim: description: |- - Claim is a name of a required claim. Only claims with string values are + claim is a name of a required claim. Only claims with string values are supported. minLength: 1 type: string requiredValue: - description: RequiredValue is the required value for + description: requiredValue is the required value for the claim. minLength: 1 type: string @@ -188,7 +188,7 @@ spec: type: object type: default: RequiredClaim - description: Type sets the type of the validation rule + description: type sets the type of the validation rule enum: - RequiredClaim type: string @@ -196,11 +196,11 @@ spec: type: array x-kubernetes-list-type: atomic issuer: - description: Issuer describes atributes of the OIDC token issuer + description: issuer describes atributes of the OIDC token issuer properties: audiences: description: |- - Audiences is an array of audiences that the token was issued for. + audiences is an array of audiences that the token was issued for. Valid tokens must include at least one of these values in their "aud" claim. Must be set to exactly one value. @@ -236,23 +236,23 @@ spec: - issuerURL type: object name: - description: Name of the OIDC provider + description: name of the OIDC provider minLength: 1 type: string oidcClients: description: |- - OIDCClients contains configuration for the platform's clients that + oidcClients contains configuration for the platform's clients that need to request tokens from the issuer items: properties: clientID: - description: ClientID is the identifier of the OIDC client + description: clientID is the identifier of the OIDC client from the OIDC provider minLength: 1 type: string clientSecret: description: |- - ClientSecret refers to a secret in the `openshift-config` namespace that + clientSecret refers to a secret in the `openshift-config` namespace that contains the client secret in the `clientSecret` key of the `.data` field properties: name: @@ -264,20 +264,20 @@ spec: type: object componentName: description: |- - ComponentName is the name of the component that is supposed to consume this + componentName is the name of the component that is supposed to consume this client configuration maxLength: 256 minLength: 1 type: string componentNamespace: description: |- - ComponentNamespace is the namespace of the component that is supposed to consume this + componentNamespace is the namespace of the component that is supposed to consume this client configuration maxLength: 63 minLength: 1 type: string extraScopes: - description: ExtraScopes is an optional set of scopes + description: extraScopes is an optional set of scopes to request tokens with. items: type: string @@ -415,25 +415,25 @@ spec: type: object oidcClients: description: |- - OIDCClients is where participating operators place the current OIDC client status + oidcClients is where participating operators place the current OIDC client status for OIDC clients that can be customized by the cluster-admin. items: properties: componentName: - description: ComponentName is the name of the component that + description: componentName is the name of the component that will consume a client configuration. maxLength: 256 minLength: 1 type: string componentNamespace: - description: ComponentNamespace is the namespace of the component + description: componentNamespace is the namespace of the component that will consume a client configuration. maxLength: 63 minLength: 1 type: string conditions: description: |- - Conditions are used to communicate the state of the `oidcClients` entry. + conditions are used to communicate the state of the `oidcClients` entry. Supported conditions include Available, Degraded and Progressing. @@ -501,7 +501,7 @@ spec: x-kubernetes-list-type: map consumingUsers: description: |- - ConsumingUsers is a slice of ServiceAccounts that need to have read + consumingUsers is a slice of ServiceAccounts that need to have read permission on the `clientSecret` secret. items: description: ConsumingUser is an alias for string which we @@ -514,12 +514,12 @@ spec: type: array x-kubernetes-list-type: set currentOIDCClients: - description: CurrentOIDCClients is a list of clients that the + description: currentOIDCClients is a list of clients that the component is currently using. items: properties: clientID: - description: ClientID is the identifier of the OIDC client + description: clientID is the identifier of the OIDC client from the OIDC provider minLength: 1 type: string diff --git a/config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_infrastructures-CustomNoUpgrade.crd.yaml b/config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_infrastructures-CustomNoUpgrade.crd.yaml index 1c97887ceca..72534aad462 100644 --- a/config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_infrastructures-CustomNoUpgrade.crd.yaml +++ b/config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_infrastructures-CustomNoUpgrade.crd.yaml @@ -62,7 +62,7 @@ spec: All the clients are expected to use the generated ConfigMap only. properties: key: - description: Key allows pointing to a specific key/value inside + description: key allows pointing to a specific key/value inside of the configmap. This is useful for logical file references. type: string name: @@ -74,11 +74,11 @@ spec: infrastructure provider. properties: alibabaCloud: - description: AlibabaCloud contains settings specific to the Alibaba + description: alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. type: object aws: - description: AWS contains settings specific to the Amazon Web + description: aws contains settings specific to the Amazon Web Services infrastructure provider. properties: serviceEndpoints: @@ -110,11 +110,11 @@ spec: x-kubernetes-list-type: atomic type: object azure: - description: Azure contains settings specific to the Azure infrastructure + description: azure contains settings specific to the Azure infrastructure provider. type: object baremetal: - description: BareMetal contains settings specific to the BareMetal + description: baremetal contains settings specific to the BareMetal platform. properties: apiServerInternalIPs: @@ -198,7 +198,7 @@ spec: - message: ingressIPs list is required once set rule: '!has(oldSelf.ingressIPs) || has(self.ingressIPs)' equinixMetal: - description: EquinixMetal contains settings specific to the Equinix + description: equinixMetal contains settings specific to the Equinix Metal infrastructure provider. type: object external: @@ -209,7 +209,7 @@ spec: platformName: default: Unknown description: |- - PlatformName holds the arbitrary string representing the infrastructure provider name, expected to be set at the installation time. + 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 x-kubernetes-validations: @@ -217,19 +217,19 @@ spec: rule: oldSelf == 'Unknown' || self == oldSelf type: object gcp: - description: GCP contains settings specific to the Google Cloud + description: gcp contains settings specific to the Google Cloud Platform infrastructure provider. type: object ibmcloud: - description: IBMCloud contains settings specific to the IBMCloud + description: ibmcloud contains settings specific to the IBMCloud infrastructure provider. type: object kubevirt: - description: Kubevirt contains settings specific to the kubevirt + description: kubevirt contains settings specific to the kubevirt infrastructure provider. type: object nutanix: - description: Nutanix contains settings specific to the Nutanix + description: nutanix contains settings specific to the Nutanix infrastructure provider. properties: failureDomains: @@ -419,7 +419,7 @@ spec: - prismElements type: object openstack: - description: OpenStack contains settings specific to the OpenStack + description: openstack contains settings specific to the OpenStack infrastructure provider. properties: apiServerInternalIPs: @@ -503,11 +503,11 @@ spec: - message: ingressIPs list is required once set rule: '!has(oldSelf.ingressIPs) || has(self.ingressIPs)' ovirt: - description: Ovirt contains settings specific to the oVirt infrastructure + description: ovirt contains settings specific to the oVirt infrastructure provider. type: object powervs: - description: PowerVS contains settings specific to the IBM Power + description: powervs contains settings specific to the IBM Power Systems Virtual Servers infrastructure provider. properties: serviceEndpoints: @@ -589,7 +589,7 @@ spec: - External type: string vsphere: - description: VSphere contains settings specific to the VSphere + description: vsphere contains settings specific to the VSphere infrastructure provider. properties: apiServerInternalIPs: @@ -674,7 +674,7 @@ spec: minLength: 1 type: string topology: - description: Topology describes a given failure domain + description: topology describes a given failure domain using vSphere constructs properties: computeCluster: @@ -1139,7 +1139,7 @@ spec: infrastructure provider. properties: alibabaCloud: - description: AlibabaCloud contains settings specific to the Alibaba + description: alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. properties: region: @@ -1182,7 +1182,7 @@ spec: - region type: object aws: - description: AWS contains settings specific to the Amazon Web + description: aws contains settings specific to the Amazon Web Services infrastructure provider. properties: cloudLoadBalancerConfig: @@ -1327,7 +1327,7 @@ spec: x-kubernetes-list-type: atomic serviceEndpoints: description: |- - ServiceEndpoints list contains custom endpoints which will override default + serviceEndpoints list contains custom endpoints which will override default service endpoint of AWS Services. There must be only one ServiceEndpoint for a service. items: @@ -1354,7 +1354,7 @@ spec: x-kubernetes-list-type: atomic type: object azure: - description: Azure contains settings specific to the Azure infrastructure + description: azure contains settings specific to the Azure infrastructure provider. properties: armEndpoint: @@ -1427,7 +1427,7 @@ spec: rule: '!has(oldSelf.resourceTags) && !has(self.resourceTags) || has(oldSelf.resourceTags) && has(self.resourceTags)' baremetal: - description: BareMetal contains settings specific to the BareMetal + description: baremetal contains settings specific to the BareMetal platform. properties: apiServerInternalIP: @@ -1537,7 +1537,7 @@ spec: type: string type: object equinixMetal: - description: EquinixMetal contains settings specific to the Equinix + description: equinixMetal contains settings specific to the Equinix Metal infrastructure provider. properties: apiServerInternalIP: @@ -1554,7 +1554,7 @@ spec: type: string type: object external: - description: External contains settings specific to the generic + description: external contains settings specific to the generic External infrastructure provider. properties: cloudControllerManager: @@ -1593,7 +1593,7 @@ spec: once set rule: has(self.cloudControllerManager) == has(oldSelf.cloudControllerManager) gcp: - description: GCP contains settings specific to the Google Cloud + description: gcp contains settings specific to the Google Cloud Platform infrastructure provider. properties: cloudLoadBalancerConfig: @@ -1816,28 +1816,28 @@ spec: rule: '!has(oldSelf.resourceTags) && !has(self.resourceTags) || has(oldSelf.resourceTags) && has(self.resourceTags)' ibmcloud: - description: IBMCloud contains settings specific to the IBMCloud + description: ibmcloud contains settings specific to the IBMCloud infrastructure provider. properties: cisInstanceCRN: description: |- - CISInstanceCRN is the CRN of the Cloud Internet Services instance managing + 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 + 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 + description: location is where the cluster has been deployed type: string providerType: - description: ProviderType indicates the type of cluster that + description: providerType indicates the type of cluster that was created type: string resourceGroupName: - description: ResourceGroupName is the Resource Group for new + description: resourceGroupName is the Resource Group for new IBMCloud resources created for the cluster. type: string serviceEndpoints: @@ -1892,7 +1892,7 @@ spec: x-kubernetes-list-type: map type: object kubevirt: - description: Kubevirt contains settings specific to the kubevirt + description: kubevirt contains settings specific to the kubevirt infrastructure provider. properties: apiServerInternalIP: @@ -1909,7 +1909,7 @@ spec: type: string type: object nutanix: - description: Nutanix contains settings specific to the Nutanix + description: nutanix contains settings specific to the Nutanix infrastructure provider. properties: apiServerInternalIP: @@ -1993,7 +1993,7 @@ spec: type: object type: object openstack: - description: OpenStack contains settings specific to the OpenStack + description: openstack contains settings specific to the OpenStack infrastructure provider. properties: apiServerInternalIP: @@ -2108,7 +2108,7 @@ spec: type: string type: object ovirt: - description: Ovirt contains settings specific to the oVirt infrastructure + description: ovirt contains settings specific to the oVirt infrastructure provider. properties: apiServerInternalIP: @@ -2196,17 +2196,17 @@ spec: type: string type: object powervs: - description: PowerVS contains settings specific to the Power Systems + description: powervs contains settings specific to the Power Systems Virtual Servers infrastructure provider. properties: cisInstanceCRN: description: |- - CISInstanceCRN is the CRN of the Cloud Internet Services instance managing + 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 + dnsInstanceCRN is the CRN of the DNS Services instance managing the DNS zone for the cluster's base domain type: string region: @@ -2316,7 +2316,7 @@ spec: - External type: string vsphere: - description: VSphere contains settings specific to the VSphere + description: vsphere contains settings specific to the VSphere infrastructure provider. properties: apiServerInternalIP: diff --git a/config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_infrastructures-Default.crd.yaml b/config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_infrastructures-Default.crd.yaml index 9a9c2e66b59..55ec17de53a 100644 --- a/config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_infrastructures-Default.crd.yaml +++ b/config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_infrastructures-Default.crd.yaml @@ -62,7 +62,7 @@ spec: All the clients are expected to use the generated ConfigMap only. properties: key: - description: Key allows pointing to a specific key/value inside + description: key allows pointing to a specific key/value inside of the configmap. This is useful for logical file references. type: string name: @@ -74,11 +74,11 @@ spec: infrastructure provider. properties: alibabaCloud: - description: AlibabaCloud contains settings specific to the Alibaba + description: alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. type: object aws: - description: AWS contains settings specific to the Amazon Web + description: aws contains settings specific to the Amazon Web Services infrastructure provider. properties: serviceEndpoints: @@ -110,11 +110,11 @@ spec: x-kubernetes-list-type: atomic type: object azure: - description: Azure contains settings specific to the Azure infrastructure + description: azure contains settings specific to the Azure infrastructure provider. type: object baremetal: - description: BareMetal contains settings specific to the BareMetal + description: baremetal contains settings specific to the BareMetal platform. properties: apiServerInternalIPs: @@ -198,7 +198,7 @@ spec: - message: ingressIPs list is required once set rule: '!has(oldSelf.ingressIPs) || has(self.ingressIPs)' equinixMetal: - description: EquinixMetal contains settings specific to the Equinix + description: equinixMetal contains settings specific to the Equinix Metal infrastructure provider. type: object external: @@ -209,7 +209,7 @@ spec: platformName: default: Unknown description: |- - PlatformName holds the arbitrary string representing the infrastructure provider name, expected to be set at the installation time. + 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 x-kubernetes-validations: @@ -217,19 +217,19 @@ spec: rule: oldSelf == 'Unknown' || self == oldSelf type: object gcp: - description: GCP contains settings specific to the Google Cloud + description: gcp contains settings specific to the Google Cloud Platform infrastructure provider. type: object ibmcloud: - description: IBMCloud contains settings specific to the IBMCloud + description: ibmcloud contains settings specific to the IBMCloud infrastructure provider. type: object kubevirt: - description: Kubevirt contains settings specific to the kubevirt + description: kubevirt contains settings specific to the kubevirt infrastructure provider. type: object nutanix: - description: Nutanix contains settings specific to the Nutanix + description: nutanix contains settings specific to the Nutanix infrastructure provider. properties: failureDomains: @@ -415,7 +415,7 @@ spec: - prismElements type: object openstack: - description: OpenStack contains settings specific to the OpenStack + description: openstack contains settings specific to the OpenStack infrastructure provider. properties: apiServerInternalIPs: @@ -499,11 +499,11 @@ spec: - message: ingressIPs list is required once set rule: '!has(oldSelf.ingressIPs) || has(self.ingressIPs)' ovirt: - description: Ovirt contains settings specific to the oVirt infrastructure + description: ovirt contains settings specific to the oVirt infrastructure provider. type: object powervs: - description: PowerVS contains settings specific to the IBM Power + description: powervs contains settings specific to the IBM Power Systems Virtual Servers infrastructure provider. properties: serviceEndpoints: @@ -585,7 +585,7 @@ spec: - External type: string vsphere: - description: VSphere contains settings specific to the VSphere + description: vsphere contains settings specific to the VSphere infrastructure provider. properties: apiServerInternalIPs: @@ -670,7 +670,7 @@ spec: minLength: 1 type: string topology: - description: Topology describes a given failure domain + description: topology describes a given failure domain using vSphere constructs properties: computeCluster: @@ -1124,7 +1124,7 @@ spec: infrastructure provider. properties: alibabaCloud: - description: AlibabaCloud contains settings specific to the Alibaba + description: alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. properties: region: @@ -1167,7 +1167,7 @@ spec: - region type: object aws: - description: AWS contains settings specific to the Amazon Web + description: aws contains settings specific to the Amazon Web Services infrastructure provider. properties: region: @@ -1208,7 +1208,7 @@ spec: x-kubernetes-list-type: atomic serviceEndpoints: description: |- - ServiceEndpoints list contains custom endpoints which will override default + serviceEndpoints list contains custom endpoints which will override default service endpoint of AWS Services. There must be only one ServiceEndpoint for a service. items: @@ -1235,7 +1235,7 @@ spec: x-kubernetes-list-type: atomic type: object azure: - description: Azure contains settings specific to the Azure infrastructure + description: azure contains settings specific to the Azure infrastructure provider. properties: armEndpoint: @@ -1308,7 +1308,7 @@ spec: rule: '!has(oldSelf.resourceTags) && !has(self.resourceTags) || has(oldSelf.resourceTags) && has(self.resourceTags)' baremetal: - description: BareMetal contains settings specific to the BareMetal + description: baremetal contains settings specific to the BareMetal platform. properties: apiServerInternalIP: @@ -1418,7 +1418,7 @@ spec: type: string type: object equinixMetal: - description: EquinixMetal contains settings specific to the Equinix + description: equinixMetal contains settings specific to the Equinix Metal infrastructure provider. properties: apiServerInternalIP: @@ -1435,7 +1435,7 @@ spec: type: string type: object external: - description: External contains settings specific to the generic + description: external contains settings specific to the generic External infrastructure provider. properties: cloudControllerManager: @@ -1474,7 +1474,7 @@ spec: once set rule: has(self.cloudControllerManager) == has(oldSelf.cloudControllerManager) gcp: - description: GCP contains settings specific to the Google Cloud + description: gcp contains settings specific to the Google Cloud Platform infrastructure provider. properties: projectID: @@ -1593,28 +1593,28 @@ spec: rule: '!has(oldSelf.resourceTags) && !has(self.resourceTags) || has(oldSelf.resourceTags) && has(self.resourceTags)' ibmcloud: - description: IBMCloud contains settings specific to the IBMCloud + description: ibmcloud contains settings specific to the IBMCloud infrastructure provider. properties: cisInstanceCRN: description: |- - CISInstanceCRN is the CRN of the Cloud Internet Services instance managing + 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 + 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 + description: location is where the cluster has been deployed type: string providerType: - description: ProviderType indicates the type of cluster that + description: providerType indicates the type of cluster that was created type: string resourceGroupName: - description: ResourceGroupName is the Resource Group for new + description: resourceGroupName is the Resource Group for new IBMCloud resources created for the cluster. type: string serviceEndpoints: @@ -1669,7 +1669,7 @@ spec: x-kubernetes-list-type: map type: object kubevirt: - description: Kubevirt contains settings specific to the kubevirt + description: kubevirt contains settings specific to the kubevirt infrastructure provider. properties: apiServerInternalIP: @@ -1686,7 +1686,7 @@ spec: type: string type: object nutanix: - description: Nutanix contains settings specific to the Nutanix + description: nutanix contains settings specific to the Nutanix infrastructure provider. properties: apiServerInternalIP: @@ -1770,7 +1770,7 @@ spec: type: object type: object openstack: - description: OpenStack contains settings specific to the OpenStack + description: openstack contains settings specific to the OpenStack infrastructure provider. properties: apiServerInternalIP: @@ -1885,7 +1885,7 @@ spec: type: string type: object ovirt: - description: Ovirt contains settings specific to the oVirt infrastructure + description: ovirt contains settings specific to the oVirt infrastructure provider. properties: apiServerInternalIP: @@ -1973,17 +1973,17 @@ spec: type: string type: object powervs: - description: PowerVS contains settings specific to the Power Systems + description: powervs contains settings specific to the Power Systems Virtual Servers infrastructure provider. properties: cisInstanceCRN: description: |- - CISInstanceCRN is the CRN of the Cloud Internet Services instance managing + 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 + dnsInstanceCRN is the CRN of the DNS Services instance managing the DNS zone for the cluster's base domain type: string region: @@ -2093,7 +2093,7 @@ spec: - External type: string vsphere: - description: VSphere contains settings specific to the VSphere + description: vsphere contains settings specific to the VSphere infrastructure provider. properties: apiServerInternalIP: diff --git a/config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_infrastructures-DevPreviewNoUpgrade.crd.yaml b/config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_infrastructures-DevPreviewNoUpgrade.crd.yaml index a6a1bc5c97e..892e64a4a75 100644 --- a/config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_infrastructures-DevPreviewNoUpgrade.crd.yaml +++ b/config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_infrastructures-DevPreviewNoUpgrade.crd.yaml @@ -62,7 +62,7 @@ spec: All the clients are expected to use the generated ConfigMap only. properties: key: - description: Key allows pointing to a specific key/value inside + description: key allows pointing to a specific key/value inside of the configmap. This is useful for logical file references. type: string name: @@ -74,11 +74,11 @@ spec: infrastructure provider. properties: alibabaCloud: - description: AlibabaCloud contains settings specific to the Alibaba + description: alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. type: object aws: - description: AWS contains settings specific to the Amazon Web + description: aws contains settings specific to the Amazon Web Services infrastructure provider. properties: serviceEndpoints: @@ -110,11 +110,11 @@ spec: x-kubernetes-list-type: atomic type: object azure: - description: Azure contains settings specific to the Azure infrastructure + description: azure contains settings specific to the Azure infrastructure provider. type: object baremetal: - description: BareMetal contains settings specific to the BareMetal + description: baremetal contains settings specific to the BareMetal platform. properties: apiServerInternalIPs: @@ -198,7 +198,7 @@ spec: - message: ingressIPs list is required once set rule: '!has(oldSelf.ingressIPs) || has(self.ingressIPs)' equinixMetal: - description: EquinixMetal contains settings specific to the Equinix + description: equinixMetal contains settings specific to the Equinix Metal infrastructure provider. type: object external: @@ -209,7 +209,7 @@ spec: platformName: default: Unknown description: |- - PlatformName holds the arbitrary string representing the infrastructure provider name, expected to be set at the installation time. + 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 x-kubernetes-validations: @@ -217,19 +217,19 @@ spec: rule: oldSelf == 'Unknown' || self == oldSelf type: object gcp: - description: GCP contains settings specific to the Google Cloud + description: gcp contains settings specific to the Google Cloud Platform infrastructure provider. type: object ibmcloud: - description: IBMCloud contains settings specific to the IBMCloud + description: ibmcloud contains settings specific to the IBMCloud infrastructure provider. type: object kubevirt: - description: Kubevirt contains settings specific to the kubevirt + description: kubevirt contains settings specific to the kubevirt infrastructure provider. type: object nutanix: - description: Nutanix contains settings specific to the Nutanix + description: nutanix contains settings specific to the Nutanix infrastructure provider. properties: failureDomains: @@ -419,7 +419,7 @@ spec: - prismElements type: object openstack: - description: OpenStack contains settings specific to the OpenStack + description: openstack contains settings specific to the OpenStack infrastructure provider. properties: apiServerInternalIPs: @@ -503,11 +503,11 @@ spec: - message: ingressIPs list is required once set rule: '!has(oldSelf.ingressIPs) || has(self.ingressIPs)' ovirt: - description: Ovirt contains settings specific to the oVirt infrastructure + description: ovirt contains settings specific to the oVirt infrastructure provider. type: object powervs: - description: PowerVS contains settings specific to the IBM Power + description: powervs contains settings specific to the IBM Power Systems Virtual Servers infrastructure provider. properties: serviceEndpoints: @@ -589,7 +589,7 @@ spec: - External type: string vsphere: - description: VSphere contains settings specific to the VSphere + description: vsphere contains settings specific to the VSphere infrastructure provider. properties: apiServerInternalIPs: @@ -674,7 +674,7 @@ spec: minLength: 1 type: string topology: - description: Topology describes a given failure domain + description: topology describes a given failure domain using vSphere constructs properties: computeCluster: @@ -1139,7 +1139,7 @@ spec: infrastructure provider. properties: alibabaCloud: - description: AlibabaCloud contains settings specific to the Alibaba + description: alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. properties: region: @@ -1182,7 +1182,7 @@ spec: - region type: object aws: - description: AWS contains settings specific to the Amazon Web + description: aws contains settings specific to the Amazon Web Services infrastructure provider. properties: cloudLoadBalancerConfig: @@ -1327,7 +1327,7 @@ spec: x-kubernetes-list-type: atomic serviceEndpoints: description: |- - ServiceEndpoints list contains custom endpoints which will override default + serviceEndpoints list contains custom endpoints which will override default service endpoint of AWS Services. There must be only one ServiceEndpoint for a service. items: @@ -1354,7 +1354,7 @@ spec: x-kubernetes-list-type: atomic type: object azure: - description: Azure contains settings specific to the Azure infrastructure + description: azure contains settings specific to the Azure infrastructure provider. properties: armEndpoint: @@ -1427,7 +1427,7 @@ spec: rule: '!has(oldSelf.resourceTags) && !has(self.resourceTags) || has(oldSelf.resourceTags) && has(self.resourceTags)' baremetal: - description: BareMetal contains settings specific to the BareMetal + description: baremetal contains settings specific to the BareMetal platform. properties: apiServerInternalIP: @@ -1537,7 +1537,7 @@ spec: type: string type: object equinixMetal: - description: EquinixMetal contains settings specific to the Equinix + description: equinixMetal contains settings specific to the Equinix Metal infrastructure provider. properties: apiServerInternalIP: @@ -1554,7 +1554,7 @@ spec: type: string type: object external: - description: External contains settings specific to the generic + description: external contains settings specific to the generic External infrastructure provider. properties: cloudControllerManager: @@ -1593,7 +1593,7 @@ spec: once set rule: has(self.cloudControllerManager) == has(oldSelf.cloudControllerManager) gcp: - description: GCP contains settings specific to the Google Cloud + description: gcp contains settings specific to the Google Cloud Platform infrastructure provider. properties: cloudLoadBalancerConfig: @@ -1816,28 +1816,28 @@ spec: rule: '!has(oldSelf.resourceTags) && !has(self.resourceTags) || has(oldSelf.resourceTags) && has(self.resourceTags)' ibmcloud: - description: IBMCloud contains settings specific to the IBMCloud + description: ibmcloud contains settings specific to the IBMCloud infrastructure provider. properties: cisInstanceCRN: description: |- - CISInstanceCRN is the CRN of the Cloud Internet Services instance managing + 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 + 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 + description: location is where the cluster has been deployed type: string providerType: - description: ProviderType indicates the type of cluster that + description: providerType indicates the type of cluster that was created type: string resourceGroupName: - description: ResourceGroupName is the Resource Group for new + description: resourceGroupName is the Resource Group for new IBMCloud resources created for the cluster. type: string serviceEndpoints: @@ -1892,7 +1892,7 @@ spec: x-kubernetes-list-type: map type: object kubevirt: - description: Kubevirt contains settings specific to the kubevirt + description: kubevirt contains settings specific to the kubevirt infrastructure provider. properties: apiServerInternalIP: @@ -1909,7 +1909,7 @@ spec: type: string type: object nutanix: - description: Nutanix contains settings specific to the Nutanix + description: nutanix contains settings specific to the Nutanix infrastructure provider. properties: apiServerInternalIP: @@ -1993,7 +1993,7 @@ spec: type: object type: object openstack: - description: OpenStack contains settings specific to the OpenStack + description: openstack contains settings specific to the OpenStack infrastructure provider. properties: apiServerInternalIP: @@ -2108,7 +2108,7 @@ spec: type: string type: object ovirt: - description: Ovirt contains settings specific to the oVirt infrastructure + description: ovirt contains settings specific to the oVirt infrastructure provider. properties: apiServerInternalIP: @@ -2196,17 +2196,17 @@ spec: type: string type: object powervs: - description: PowerVS contains settings specific to the Power Systems + description: powervs contains settings specific to the Power Systems Virtual Servers infrastructure provider. properties: cisInstanceCRN: description: |- - CISInstanceCRN is the CRN of the Cloud Internet Services instance managing + 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 + dnsInstanceCRN is the CRN of the DNS Services instance managing the DNS zone for the cluster's base domain type: string region: @@ -2316,7 +2316,7 @@ spec: - External type: string vsphere: - description: VSphere contains settings specific to the VSphere + description: vsphere contains settings specific to the VSphere infrastructure provider. properties: apiServerInternalIP: diff --git a/config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_infrastructures-TechPreviewNoUpgrade.crd.yaml b/config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_infrastructures-TechPreviewNoUpgrade.crd.yaml index 2be308fe0ff..cec1689db66 100644 --- a/config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_infrastructures-TechPreviewNoUpgrade.crd.yaml +++ b/config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_infrastructures-TechPreviewNoUpgrade.crd.yaml @@ -62,7 +62,7 @@ spec: All the clients are expected to use the generated ConfigMap only. properties: key: - description: Key allows pointing to a specific key/value inside + description: key allows pointing to a specific key/value inside of the configmap. This is useful for logical file references. type: string name: @@ -74,11 +74,11 @@ spec: infrastructure provider. properties: alibabaCloud: - description: AlibabaCloud contains settings specific to the Alibaba + description: alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. type: object aws: - description: AWS contains settings specific to the Amazon Web + description: aws contains settings specific to the Amazon Web Services infrastructure provider. properties: serviceEndpoints: @@ -110,11 +110,11 @@ spec: x-kubernetes-list-type: atomic type: object azure: - description: Azure contains settings specific to the Azure infrastructure + description: azure contains settings specific to the Azure infrastructure provider. type: object baremetal: - description: BareMetal contains settings specific to the BareMetal + description: baremetal contains settings specific to the BareMetal platform. properties: apiServerInternalIPs: @@ -198,7 +198,7 @@ spec: - message: ingressIPs list is required once set rule: '!has(oldSelf.ingressIPs) || has(self.ingressIPs)' equinixMetal: - description: EquinixMetal contains settings specific to the Equinix + description: equinixMetal contains settings specific to the Equinix Metal infrastructure provider. type: object external: @@ -209,7 +209,7 @@ spec: platformName: default: Unknown description: |- - PlatformName holds the arbitrary string representing the infrastructure provider name, expected to be set at the installation time. + 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 x-kubernetes-validations: @@ -217,19 +217,19 @@ spec: rule: oldSelf == 'Unknown' || self == oldSelf type: object gcp: - description: GCP contains settings specific to the Google Cloud + description: gcp contains settings specific to the Google Cloud Platform infrastructure provider. type: object ibmcloud: - description: IBMCloud contains settings specific to the IBMCloud + description: ibmcloud contains settings specific to the IBMCloud infrastructure provider. type: object kubevirt: - description: Kubevirt contains settings specific to the kubevirt + description: kubevirt contains settings specific to the kubevirt infrastructure provider. type: object nutanix: - description: Nutanix contains settings specific to the Nutanix + description: nutanix contains settings specific to the Nutanix infrastructure provider. properties: failureDomains: @@ -419,7 +419,7 @@ spec: - prismElements type: object openstack: - description: OpenStack contains settings specific to the OpenStack + description: openstack contains settings specific to the OpenStack infrastructure provider. properties: apiServerInternalIPs: @@ -503,11 +503,11 @@ spec: - message: ingressIPs list is required once set rule: '!has(oldSelf.ingressIPs) || has(self.ingressIPs)' ovirt: - description: Ovirt contains settings specific to the oVirt infrastructure + description: ovirt contains settings specific to the oVirt infrastructure provider. type: object powervs: - description: PowerVS contains settings specific to the IBM Power + description: powervs contains settings specific to the IBM Power Systems Virtual Servers infrastructure provider. properties: serviceEndpoints: @@ -589,7 +589,7 @@ spec: - External type: string vsphere: - description: VSphere contains settings specific to the VSphere + description: vsphere contains settings specific to the VSphere infrastructure provider. properties: apiServerInternalIPs: @@ -674,7 +674,7 @@ spec: minLength: 1 type: string topology: - description: Topology describes a given failure domain + description: topology describes a given failure domain using vSphere constructs properties: computeCluster: @@ -1139,7 +1139,7 @@ spec: infrastructure provider. properties: alibabaCloud: - description: AlibabaCloud contains settings specific to the Alibaba + description: alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. properties: region: @@ -1182,7 +1182,7 @@ spec: - region type: object aws: - description: AWS contains settings specific to the Amazon Web + description: aws contains settings specific to the Amazon Web Services infrastructure provider. properties: cloudLoadBalancerConfig: @@ -1327,7 +1327,7 @@ spec: x-kubernetes-list-type: atomic serviceEndpoints: description: |- - ServiceEndpoints list contains custom endpoints which will override default + serviceEndpoints list contains custom endpoints which will override default service endpoint of AWS Services. There must be only one ServiceEndpoint for a service. items: @@ -1354,7 +1354,7 @@ spec: x-kubernetes-list-type: atomic type: object azure: - description: Azure contains settings specific to the Azure infrastructure + description: azure contains settings specific to the Azure infrastructure provider. properties: armEndpoint: @@ -1427,7 +1427,7 @@ spec: rule: '!has(oldSelf.resourceTags) && !has(self.resourceTags) || has(oldSelf.resourceTags) && has(self.resourceTags)' baremetal: - description: BareMetal contains settings specific to the BareMetal + description: baremetal contains settings specific to the BareMetal platform. properties: apiServerInternalIP: @@ -1537,7 +1537,7 @@ spec: type: string type: object equinixMetal: - description: EquinixMetal contains settings specific to the Equinix + description: equinixMetal contains settings specific to the Equinix Metal infrastructure provider. properties: apiServerInternalIP: @@ -1554,7 +1554,7 @@ spec: type: string type: object external: - description: External contains settings specific to the generic + description: external contains settings specific to the generic External infrastructure provider. properties: cloudControllerManager: @@ -1593,7 +1593,7 @@ spec: once set rule: has(self.cloudControllerManager) == has(oldSelf.cloudControllerManager) gcp: - description: GCP contains settings specific to the Google Cloud + description: gcp contains settings specific to the Google Cloud Platform infrastructure provider. properties: cloudLoadBalancerConfig: @@ -1816,28 +1816,28 @@ spec: rule: '!has(oldSelf.resourceTags) && !has(self.resourceTags) || has(oldSelf.resourceTags) && has(self.resourceTags)' ibmcloud: - description: IBMCloud contains settings specific to the IBMCloud + description: ibmcloud contains settings specific to the IBMCloud infrastructure provider. properties: cisInstanceCRN: description: |- - CISInstanceCRN is the CRN of the Cloud Internet Services instance managing + 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 + 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 + description: location is where the cluster has been deployed type: string providerType: - description: ProviderType indicates the type of cluster that + description: providerType indicates the type of cluster that was created type: string resourceGroupName: - description: ResourceGroupName is the Resource Group for new + description: resourceGroupName is the Resource Group for new IBMCloud resources created for the cluster. type: string serviceEndpoints: @@ -1892,7 +1892,7 @@ spec: x-kubernetes-list-type: map type: object kubevirt: - description: Kubevirt contains settings specific to the kubevirt + description: kubevirt contains settings specific to the kubevirt infrastructure provider. properties: apiServerInternalIP: @@ -1909,7 +1909,7 @@ spec: type: string type: object nutanix: - description: Nutanix contains settings specific to the Nutanix + description: nutanix contains settings specific to the Nutanix infrastructure provider. properties: apiServerInternalIP: @@ -1993,7 +1993,7 @@ spec: type: object type: object openstack: - description: OpenStack contains settings specific to the OpenStack + description: openstack contains settings specific to the OpenStack infrastructure provider. properties: apiServerInternalIP: @@ -2108,7 +2108,7 @@ spec: type: string type: object ovirt: - description: Ovirt contains settings specific to the oVirt infrastructure + description: ovirt contains settings specific to the oVirt infrastructure provider. properties: apiServerInternalIP: @@ -2196,17 +2196,17 @@ spec: type: string type: object powervs: - description: PowerVS contains settings specific to the Power Systems + description: powervs contains settings specific to the Power Systems Virtual Servers infrastructure provider. properties: cisInstanceCRN: description: |- - CISInstanceCRN is the CRN of the Cloud Internet Services instance managing + 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 + dnsInstanceCRN is the CRN of the DNS Services instance managing the DNS zone for the cluster's base domain type: string region: @@ -2316,7 +2316,7 @@ spec: - External type: string vsphere: - description: VSphere contains settings specific to the VSphere + description: vsphere contains settings specific to the VSphere infrastructure provider. properties: apiServerInternalIP: diff --git a/config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_networks.crd.yaml b/config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_networks.crd.yaml index 49db650d7aa..fac73b78fa9 100644 --- a/config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_networks.crd.yaml +++ b/config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_networks.crd.yaml @@ -260,7 +260,7 @@ spec: type: object networkType: description: |- - NetworkType is the plugin that is to be deployed (e.g. OVNKubernetes). + 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: @@ -318,7 +318,7 @@ spec: type: array x-kubernetes-list-type: atomic clusterNetworkMTU: - description: ClusterNetworkMTU is the MTU for inter-pod networking. + description: clusterNetworkMTU is the MTU for inter-pod networking. type: integer conditions: description: |- @@ -383,13 +383,13 @@ spec: - type x-kubernetes-list-type: map migration: - description: Migration contains the cluster network migration configuration. + description: migration contains the cluster network migration configuration. properties: mtu: - description: MTU is the MTU configuration that is being deployed. + description: mtu is the MTU configuration that is being deployed. properties: machine: - description: Machine contains MTU migration configuration + description: machine contains MTU migration configuration for the machine's uplink. properties: from: @@ -404,7 +404,7 @@ spec: type: integer type: object network: - description: Network contains MTU migration configuration + description: network contains MTU migration configuration for the default network. properties: from: @@ -421,13 +421,13 @@ spec: type: object networkType: description: |- - NetworkType is the target plugin that is being deployed. + 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 type: object networkType: - description: NetworkType is the plugin that is deployed (e.g. OVNKubernetes). + description: networkType is the plugin that is deployed (e.g. OVNKubernetes). type: string serviceNetwork: description: |- diff --git a/config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_nodes-CustomNoUpgrade.crd.yaml b/config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_nodes-CustomNoUpgrade.crd.yaml index 469400577ae..776be2eeb6d 100644 --- a/config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_nodes-CustomNoUpgrade.crd.yaml +++ b/config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_nodes-CustomNoUpgrade.crd.yaml @@ -47,7 +47,7 @@ spec: description: spec holds user settable values for configuration properties: cgroupMode: - description: CgroupMode determines the cgroups version on the node + description: cgroupMode determines the cgroups version on the node enum: - v1 - v2 @@ -76,7 +76,7 @@ spec: rule: self == "" || self.matches('^[0-9]*.[0-9]*.[0-9]*$') workerLatencyProfile: description: |- - WorkerLatencyProfile determins the how fast the kubelet is updating + workerLatencyProfile determins the how fast the kubelet is updating the status and corresponding reaction of the cluster enum: - Default diff --git a/config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_nodes-Default.crd.yaml b/config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_nodes-Default.crd.yaml index b79a394c6e1..a4d69857db0 100644 --- a/config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_nodes-Default.crd.yaml +++ b/config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_nodes-Default.crd.yaml @@ -47,7 +47,7 @@ spec: description: spec holds user settable values for configuration properties: cgroupMode: - description: CgroupMode determines the cgroups version on the node + description: cgroupMode determines the cgroups version on the node enum: - v1 - v2 @@ -55,7 +55,7 @@ spec: type: string workerLatencyProfile: description: |- - WorkerLatencyProfile determins the how fast the kubelet is updating + workerLatencyProfile determins the how fast the kubelet is updating the status and corresponding reaction of the cluster enum: - Default diff --git a/config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_nodes-DevPreviewNoUpgrade.crd.yaml b/config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_nodes-DevPreviewNoUpgrade.crd.yaml index 99b124d5728..00413af2e24 100644 --- a/config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_nodes-DevPreviewNoUpgrade.crd.yaml +++ b/config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_nodes-DevPreviewNoUpgrade.crd.yaml @@ -47,7 +47,7 @@ spec: description: spec holds user settable values for configuration properties: cgroupMode: - description: CgroupMode determines the cgroups version on the node + description: cgroupMode determines the cgroups version on the node enum: - v1 - v2 @@ -76,7 +76,7 @@ spec: rule: self == "" || self.matches('^[0-9]*.[0-9]*.[0-9]*$') workerLatencyProfile: description: |- - WorkerLatencyProfile determins the how fast the kubelet is updating + workerLatencyProfile determins the how fast the kubelet is updating the status and corresponding reaction of the cluster enum: - Default diff --git a/config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_nodes-TechPreviewNoUpgrade.crd.yaml b/config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_nodes-TechPreviewNoUpgrade.crd.yaml index 8db838df772..8504be1e39b 100644 --- a/config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_nodes-TechPreviewNoUpgrade.crd.yaml +++ b/config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_nodes-TechPreviewNoUpgrade.crd.yaml @@ -47,7 +47,7 @@ spec: description: spec holds user settable values for configuration properties: cgroupMode: - description: CgroupMode determines the cgroups version on the node + description: cgroupMode determines the cgroups version on the node enum: - v1 - v2 @@ -76,7 +76,7 @@ spec: rule: self == "" || self.matches('^[0-9]*.[0-9]*.[0-9]*$') workerLatencyProfile: description: |- - WorkerLatencyProfile determins the how fast the kubelet is updating + workerLatencyProfile determins the how fast the kubelet is updating the status and corresponding reaction of the cluster enum: - Default 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 index f557085f8fd..d058dd7dccc 100644 --- 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 @@ -72,7 +72,7 @@ spec: type: string mastersSchedulable: description: |- - MastersSchedulable allows masters nodes to be schedulable. When this flag is + 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. 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-Default.crd.yaml index cbfff13ab79..37abbe9a533 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-Default.crd.yaml @@ -72,7 +72,7 @@ spec: type: string mastersSchedulable: description: |- - MastersSchedulable allows masters nodes to be schedulable. When this flag is + 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. 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 index 39aae9ecede..a62eb09733f 100644 --- 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 @@ -72,7 +72,7 @@ spec: type: string mastersSchedulable: description: |- - MastersSchedulable allows masters nodes to be schedulable. When this flag is + 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. 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 index 34b79b3f1fc..24fbbb3021f 100644 --- 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 @@ -72,7 +72,7 @@ spec: type: string mastersSchedulable: description: |- - MastersSchedulable allows masters nodes to be schedulable. When this flag is + 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. diff --git a/config/v1/zz_generated.crd-manifests/0000_10_openshift-controller-manager_01_builds.crd.yaml b/config/v1/zz_generated.crd-manifests/0000_10_openshift-controller-manager_01_builds.crd.yaml index 34ca783627a..eeebfbbeb2d 100644 --- a/config/v1/zz_generated.crd-manifests/0000_10_openshift-controller-manager_01_builds.crd.yaml +++ b/config/v1/zz_generated.crd-manifests/0000_10_openshift-controller-manager_01_builds.crd.yaml @@ -46,12 +46,12 @@ spec: metadata: type: object spec: - description: Spec holds user-settable values for the build controller + description: spec holds user-settable values for the build controller configuration properties: additionalTrustedCA: description: |- - AdditionalTrustedCA is a reference to a ConfigMap containing additional CAs that + 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. @@ -66,11 +66,11 @@ spec: - name type: object buildDefaults: - description: BuildDefaults controls the default information for Builds + description: buildDefaults controls the default information for Builds properties: defaultProxy: description: |- - DefaultProxy contains the default proxy settings for all build operations, including image pull/push + defaultProxy contains the default proxy settings for all build operations, including image pull/push and source download. Values can be overrode by setting the `HTTP_PROXY`, `HTTPS_PROXY`, and `NO_PROXY` environment variables @@ -132,7 +132,7 @@ spec: type: object env: description: |- - Env is a set of default environment variables that will be applied to the + 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 items: description: EnvVar represents an environment variable present @@ -254,7 +254,7 @@ spec: type: array gitProxy: description: |- - GitProxy contains the proxy settings for git operations only. If set, this will override + 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. Values that are not set here will be inherited from DefaultProxy. @@ -315,22 +315,22 @@ spec: type: object imageLabels: description: |- - ImageLabels is a list of docker labels that are applied to the resulting image. + 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. items: properties: name: - description: Name defines the name of the label. It must + description: name defines the name of the label. It must have non-zero length. type: string value: - description: Value defines the literal value of the label. + description: value defines the literal value of the label. type: string type: object type: array resources: - description: Resources defines resource requirements to execute + description: resources defines resource requirements to execute the build. properties: claims: @@ -391,7 +391,7 @@ spec: type: object type: object buildOverrides: - description: BuildOverrides controls override settings for builds + description: buildOverrides controls override settings for builds properties: forcePull: description: |- @@ -402,24 +402,24 @@ spec: type: boolean imageLabels: description: |- - ImageLabels is a list of docker labels that are applied to the resulting image. + 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. items: properties: name: - description: Name defines the name of the label. It must + description: name defines the name of the label. It must have non-zero length. type: string value: - description: Value defines the literal value of the label. + description: value defines the literal value of the label. type: string type: object type: array nodeSelector: additionalProperties: type: string - description: NodeSelector is a selector which must be true for + description: nodeSelector is a selector which must be true for the build pod to fit on a node type: object tolerations: diff --git a/config/v1/zz_generated.featuregated-crd-manifests/authentications.config.openshift.io/ExternalOIDC.yaml b/config/v1/zz_generated.featuregated-crd-manifests/authentications.config.openshift.io/ExternalOIDC.yaml index 9deb14b38e2..91de3ce5a85 100644 --- a/config/v1/zz_generated.featuregated-crd-manifests/authentications.config.openshift.io/ExternalOIDC.yaml +++ b/config/v1/zz_generated.featuregated-crd-manifests/authentications.config.openshift.io/ExternalOIDC.yaml @@ -71,7 +71,7 @@ spec: type: object oidcProviders: description: |- - OIDCProviders are OIDC identity providers that can issue tokens + oidcProviders are OIDC identity providers that can issue tokens for this cluster Can only be set if "Type" is set to "OIDC". @@ -80,22 +80,22 @@ spec: properties: claimMappings: description: |- - ClaimMappings describes rules on how to transform information from an + claimMappings describes rules on how to transform information from an ID token into a cluster identity properties: groups: description: |- - Groups is a name of the claim that should be used to construct + groups is a name of the claim that should be used to construct groups for the cluster identity. The referenced claim must use array of strings values. properties: claim: - description: Claim is a JWT token claim to be used in + description: claim is a JWT token claim to be used in the mapping type: string prefix: description: |- - Prefix is a string to prefix the value from the token in the result of the + prefix is a string to prefix the value from the token in the result of the claim mapping. By default, no prefixing occurs. @@ -109,13 +109,13 @@ spec: type: object username: description: |- - Username is a name of the claim that should be used to construct + username is a name of the claim that should be used to construct usernames for the cluster identity. Default value: "sub" properties: claim: - description: Claim is a JWT token claim to be used in + description: claim is a JWT token claim to be used in the mapping type: string prefix: @@ -128,7 +128,7 @@ spec: type: object prefixPolicy: description: |- - PrefixPolicy specifies how a prefix should apply. + prefixPolicy specifies how a prefix should apply. By default, claims other than `email` will be prefixed with the issuer URL to prevent naming clashes with other plugins. @@ -163,23 +163,23 @@ spec: > 0) : !has(self.prefix)' type: object claimValidationRules: - description: ClaimValidationRules are rules that are applied + description: claimValidationRules are rules that are applied to validate token claims to authenticate users. items: properties: requiredClaim: description: |- - RequiredClaim allows configuring a required claim name and its expected + requiredClaim allows configuring a required claim name and its expected value properties: claim: description: |- - Claim is a name of a required claim. Only claims with string values are + claim is a name of a required claim. Only claims with string values are supported. minLength: 1 type: string requiredValue: - description: RequiredValue is the required value for + description: requiredValue is the required value for the claim. minLength: 1 type: string @@ -189,7 +189,7 @@ spec: type: object type: default: RequiredClaim - description: Type sets the type of the validation rule + description: type sets the type of the validation rule enum: - RequiredClaim type: string @@ -197,11 +197,11 @@ spec: type: array x-kubernetes-list-type: atomic issuer: - description: Issuer describes atributes of the OIDC token issuer + description: issuer describes atributes of the OIDC token issuer properties: audiences: description: |- - Audiences is an array of audiences that the token was issued for. + audiences is an array of audiences that the token was issued for. Valid tokens must include at least one of these values in their "aud" claim. Must be set to exactly one value. @@ -237,23 +237,23 @@ spec: - issuerURL type: object name: - description: Name of the OIDC provider + description: name of the OIDC provider minLength: 1 type: string oidcClients: description: |- - OIDCClients contains configuration for the platform's clients that + oidcClients contains configuration for the platform's clients that need to request tokens from the issuer items: properties: clientID: - description: ClientID is the identifier of the OIDC client + description: clientID is the identifier of the OIDC client from the OIDC provider minLength: 1 type: string clientSecret: description: |- - ClientSecret refers to a secret in the `openshift-config` namespace that + clientSecret refers to a secret in the `openshift-config` namespace that contains the client secret in the `clientSecret` key of the `.data` field properties: name: @@ -265,20 +265,20 @@ spec: type: object componentName: description: |- - ComponentName is the name of the component that is supposed to consume this + componentName is the name of the component that is supposed to consume this client configuration maxLength: 256 minLength: 1 type: string componentNamespace: description: |- - ComponentNamespace is the namespace of the component that is supposed to consume this + componentNamespace is the namespace of the component that is supposed to consume this client configuration maxLength: 63 minLength: 1 type: string extraScopes: - description: ExtraScopes is an optional set of scopes + description: extraScopes is an optional set of scopes to request tokens with. items: type: string @@ -416,25 +416,25 @@ spec: type: object oidcClients: description: |- - OIDCClients is where participating operators place the current OIDC client status + oidcClients is where participating operators place the current OIDC client status for OIDC clients that can be customized by the cluster-admin. items: properties: componentName: - description: ComponentName is the name of the component that + description: componentName is the name of the component that will consume a client configuration. maxLength: 256 minLength: 1 type: string componentNamespace: - description: ComponentNamespace is the namespace of the component + description: componentNamespace is the namespace of the component that will consume a client configuration. maxLength: 63 minLength: 1 type: string conditions: description: |- - Conditions are used to communicate the state of the `oidcClients` entry. + conditions are used to communicate the state of the `oidcClients` entry. Supported conditions include Available, Degraded and Progressing. @@ -502,7 +502,7 @@ spec: x-kubernetes-list-type: map consumingUsers: description: |- - ConsumingUsers is a slice of ServiceAccounts that need to have read + consumingUsers is a slice of ServiceAccounts that need to have read permission on the `clientSecret` secret. items: description: ConsumingUser is an alias for string which we @@ -515,12 +515,12 @@ spec: type: array x-kubernetes-list-type: set currentOIDCClients: - description: CurrentOIDCClients is a list of clients that the + description: currentOIDCClients is a list of clients that the component is currently using. items: properties: clientID: - description: ClientID is the identifier of the OIDC client + description: clientID is the identifier of the OIDC client from the OIDC provider minLength: 1 type: string diff --git a/config/v1/zz_generated.featuregated-crd-manifests/builds.config.openshift.io/AAA_ungated.yaml b/config/v1/zz_generated.featuregated-crd-manifests/builds.config.openshift.io/AAA_ungated.yaml index 63b9b006578..15b675eae2d 100644 --- a/config/v1/zz_generated.featuregated-crd-manifests/builds.config.openshift.io/AAA_ungated.yaml +++ b/config/v1/zz_generated.featuregated-crd-manifests/builds.config.openshift.io/AAA_ungated.yaml @@ -47,12 +47,12 @@ spec: metadata: type: object spec: - description: Spec holds user-settable values for the build controller + description: spec holds user-settable values for the build controller configuration properties: additionalTrustedCA: description: |- - AdditionalTrustedCA is a reference to a ConfigMap containing additional CAs that + 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. @@ -67,11 +67,11 @@ spec: - name type: object buildDefaults: - description: BuildDefaults controls the default information for Builds + description: buildDefaults controls the default information for Builds properties: defaultProxy: description: |- - DefaultProxy contains the default proxy settings for all build operations, including image pull/push + defaultProxy contains the default proxy settings for all build operations, including image pull/push and source download. Values can be overrode by setting the `HTTP_PROXY`, `HTTPS_PROXY`, and `NO_PROXY` environment variables @@ -133,7 +133,7 @@ spec: type: object env: description: |- - Env is a set of default environment variables that will be applied to the + 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 items: description: EnvVar represents an environment variable present @@ -255,7 +255,7 @@ spec: type: array gitProxy: description: |- - GitProxy contains the proxy settings for git operations only. If set, this will override + 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. Values that are not set here will be inherited from DefaultProxy. @@ -316,22 +316,22 @@ spec: type: object imageLabels: description: |- - ImageLabels is a list of docker labels that are applied to the resulting image. + 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. items: properties: name: - description: Name defines the name of the label. It must + description: name defines the name of the label. It must have non-zero length. type: string value: - description: Value defines the literal value of the label. + description: value defines the literal value of the label. type: string type: object type: array resources: - description: Resources defines resource requirements to execute + description: resources defines resource requirements to execute the build. properties: claims: @@ -392,7 +392,7 @@ spec: type: object type: object buildOverrides: - description: BuildOverrides controls override settings for builds + description: buildOverrides controls override settings for builds properties: forcePull: description: |- @@ -403,24 +403,24 @@ spec: type: boolean imageLabels: description: |- - ImageLabels is a list of docker labels that are applied to the resulting image. + 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. items: properties: name: - description: Name defines the name of the label. It must + description: name defines the name of the label. It must have non-zero length. type: string value: - description: Value defines the literal value of the label. + description: value defines the literal value of the label. type: string type: object type: array nodeSelector: additionalProperties: type: string - description: NodeSelector is a selector which must be true for + description: nodeSelector is a selector which must be true for the build pod to fit on a node type: object tolerations: diff --git a/config/v1/zz_generated.featuregated-crd-manifests/clusterversions.config.openshift.io/AAA_ungated.yaml b/config/v1/zz_generated.featuregated-crd-manifests/clusterversions.config.openshift.io/AAA_ungated.yaml index e811b9d543f..e7c0db92729 100644 --- a/config/v1/zz_generated.featuregated-crd-manifests/clusterversions.config.openshift.io/AAA_ungated.yaml +++ b/config/v1/zz_generated.featuregated-crd-manifests/clusterversions.config.openshift.io/AAA_ungated.yaml @@ -196,10 +196,10 @@ spec: x-kubernetes-validations: - message: cannot set both Architecture and Image rule: 'has(self.architecture) && has(self.image) ? (self.architecture - == '''' || self.image == '''') : true' + == "" || self.image == "") : true' - message: Version must be set if Architecture is set - rule: 'has(self.architecture) && self.architecture != '''' ? self.version - != '''' : true' + rule: 'has(self.architecture) && self.architecture != "" ? self.version + != "" : true' overrides: description: |- overrides is list of overides for components that are managed by @@ -503,12 +503,12 @@ spec: fail to evaluate. properties: promql: - description: promQL represents a cluster condition + description: promql represents a cluster condition based on PromQL. properties: promql: description: |- - PromQL is a PromQL query classifying clusters. This query + 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 diff --git a/config/v1/zz_generated.featuregated-crd-manifests/clusterversions.config.openshift.io/SignatureStores.yaml b/config/v1/zz_generated.featuregated-crd-manifests/clusterversions.config.openshift.io/SignatureStores.yaml index d7b84e3d828..b3047a97bbb 100644 --- a/config/v1/zz_generated.featuregated-crd-manifests/clusterversions.config.openshift.io/SignatureStores.yaml +++ b/config/v1/zz_generated.featuregated-crd-manifests/clusterversions.config.openshift.io/SignatureStores.yaml @@ -196,10 +196,10 @@ spec: x-kubernetes-validations: - message: cannot set both Architecture and Image rule: 'has(self.architecture) && has(self.image) ? (self.architecture - == '''' || self.image == '''') : true' + == "" || self.image == "") : true' - message: Version must be set if Architecture is set - rule: 'has(self.architecture) && self.architecture != '''' ? self.version - != '''' : true' + rule: 'has(self.architecture) && self.architecture != "" ? self.version + != "" : true' overrides: description: |- overrides is list of overides for components that are managed by @@ -554,12 +554,12 @@ spec: fail to evaluate. properties: promql: - description: promQL represents a cluster condition + description: promql represents a cluster condition based on PromQL. properties: promql: description: |- - PromQL is a PromQL query classifying clusters. This query + 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 diff --git a/config/v1/zz_generated.featuregated-crd-manifests/infrastructures.config.openshift.io/AAA_ungated.yaml b/config/v1/zz_generated.featuregated-crd-manifests/infrastructures.config.openshift.io/AAA_ungated.yaml index f7f2501ebff..a43246cbaca 100644 --- a/config/v1/zz_generated.featuregated-crd-manifests/infrastructures.config.openshift.io/AAA_ungated.yaml +++ b/config/v1/zz_generated.featuregated-crd-manifests/infrastructures.config.openshift.io/AAA_ungated.yaml @@ -62,7 +62,7 @@ spec: All the clients are expected to use the generated ConfigMap only. properties: key: - description: Key allows pointing to a specific key/value inside + description: key allows pointing to a specific key/value inside of the configmap. This is useful for logical file references. type: string name: @@ -74,11 +74,11 @@ spec: infrastructure provider. properties: alibabaCloud: - description: AlibabaCloud contains settings specific to the Alibaba + description: alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. type: object aws: - description: AWS contains settings specific to the Amazon Web + description: aws contains settings specific to the Amazon Web Services infrastructure provider. properties: serviceEndpoints: @@ -110,11 +110,11 @@ spec: x-kubernetes-list-type: atomic type: object azure: - description: Azure contains settings specific to the Azure infrastructure + description: azure contains settings specific to the Azure infrastructure provider. type: object baremetal: - description: BareMetal contains settings specific to the BareMetal + description: baremetal contains settings specific to the BareMetal platform. properties: apiServerInternalIPs: @@ -198,7 +198,7 @@ spec: - message: ingressIPs list is required once set rule: '!has(oldSelf.ingressIPs) || has(self.ingressIPs)' equinixMetal: - description: EquinixMetal contains settings specific to the Equinix + description: equinixMetal contains settings specific to the Equinix Metal infrastructure provider. type: object external: @@ -209,7 +209,7 @@ spec: platformName: default: Unknown description: |- - PlatformName holds the arbitrary string representing the infrastructure provider name, expected to be set at the installation time. + 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 x-kubernetes-validations: @@ -217,19 +217,19 @@ spec: rule: oldSelf == 'Unknown' || self == oldSelf type: object gcp: - description: GCP contains settings specific to the Google Cloud + description: gcp contains settings specific to the Google Cloud Platform infrastructure provider. type: object ibmcloud: - description: IBMCloud contains settings specific to the IBMCloud + description: ibmcloud contains settings specific to the IBMCloud infrastructure provider. type: object kubevirt: - description: Kubevirt contains settings specific to the kubevirt + description: kubevirt contains settings specific to the kubevirt infrastructure provider. type: object nutanix: - description: Nutanix contains settings specific to the Nutanix + description: nutanix contains settings specific to the Nutanix infrastructure provider. properties: failureDomains: @@ -415,7 +415,7 @@ spec: - prismElements type: object openstack: - description: OpenStack contains settings specific to the OpenStack + description: openstack contains settings specific to the OpenStack infrastructure provider. properties: apiServerInternalIPs: @@ -499,11 +499,11 @@ spec: - message: ingressIPs list is required once set rule: '!has(oldSelf.ingressIPs) || has(self.ingressIPs)' ovirt: - description: Ovirt contains settings specific to the oVirt infrastructure + description: ovirt contains settings specific to the oVirt infrastructure provider. type: object powervs: - description: PowerVS contains settings specific to the IBM Power + description: powervs contains settings specific to the IBM Power Systems Virtual Servers infrastructure provider. properties: serviceEndpoints: @@ -585,7 +585,7 @@ spec: - External type: string vsphere: - description: VSphere contains settings specific to the VSphere + description: vsphere contains settings specific to the VSphere infrastructure provider. properties: apiServerInternalIPs: @@ -666,7 +666,7 @@ spec: minLength: 1 type: string topology: - description: Topology describes a given failure domain + description: topology describes a given failure domain using vSphere constructs properties: computeCluster: @@ -1097,7 +1097,7 @@ spec: infrastructure provider. properties: alibabaCloud: - description: AlibabaCloud contains settings specific to the Alibaba + description: alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. properties: region: @@ -1140,7 +1140,7 @@ spec: - region type: object aws: - description: AWS contains settings specific to the Amazon Web + description: aws contains settings specific to the Amazon Web Services infrastructure provider. properties: region: @@ -1181,7 +1181,7 @@ spec: x-kubernetes-list-type: atomic serviceEndpoints: description: |- - ServiceEndpoints list contains custom endpoints which will override default + serviceEndpoints list contains custom endpoints which will override default service endpoint of AWS Services. There must be only one ServiceEndpoint for a service. items: @@ -1208,7 +1208,7 @@ spec: x-kubernetes-list-type: atomic type: object azure: - description: Azure contains settings specific to the Azure infrastructure + description: azure contains settings specific to the Azure infrastructure provider. properties: armEndpoint: @@ -1281,7 +1281,7 @@ spec: rule: '!has(oldSelf.resourceTags) && !has(self.resourceTags) || has(oldSelf.resourceTags) && has(self.resourceTags)' baremetal: - description: BareMetal contains settings specific to the BareMetal + description: baremetal contains settings specific to the BareMetal platform. properties: apiServerInternalIP: @@ -1365,7 +1365,7 @@ spec: type: string type: object equinixMetal: - description: EquinixMetal contains settings specific to the Equinix + description: equinixMetal contains settings specific to the Equinix Metal infrastructure provider. properties: apiServerInternalIP: @@ -1382,7 +1382,7 @@ spec: type: string type: object external: - description: External contains settings specific to the generic + description: external contains settings specific to the generic External infrastructure provider. properties: cloudControllerManager: @@ -1421,7 +1421,7 @@ spec: once set rule: has(self.cloudControllerManager) == has(oldSelf.cloudControllerManager) gcp: - description: GCP contains settings specific to the Google Cloud + description: gcp contains settings specific to the Google Cloud Platform infrastructure provider. properties: projectID: @@ -1434,28 +1434,28 @@ spec: type: string type: object ibmcloud: - description: IBMCloud contains settings specific to the IBMCloud + description: ibmcloud contains settings specific to the IBMCloud infrastructure provider. properties: cisInstanceCRN: description: |- - CISInstanceCRN is the CRN of the Cloud Internet Services instance managing + 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 + 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 + description: location is where the cluster has been deployed type: string providerType: - description: ProviderType indicates the type of cluster that + description: providerType indicates the type of cluster that was created type: string resourceGroupName: - description: ResourceGroupName is the Resource Group for new + description: resourceGroupName is the Resource Group for new IBMCloud resources created for the cluster. type: string serviceEndpoints: @@ -1510,7 +1510,7 @@ spec: x-kubernetes-list-type: map type: object kubevirt: - description: Kubevirt contains settings specific to the kubevirt + description: kubevirt contains settings specific to the kubevirt infrastructure provider. properties: apiServerInternalIP: @@ -1527,7 +1527,7 @@ spec: type: string type: object nutanix: - description: Nutanix contains settings specific to the Nutanix + description: nutanix contains settings specific to the Nutanix infrastructure provider. properties: apiServerInternalIP: @@ -1585,7 +1585,7 @@ spec: : true)' type: object openstack: - description: OpenStack contains settings specific to the OpenStack + description: openstack contains settings specific to the OpenStack infrastructure provider. properties: apiServerInternalIP: @@ -1700,7 +1700,7 @@ spec: type: string type: object ovirt: - description: Ovirt contains settings specific to the oVirt infrastructure + description: ovirt contains settings specific to the oVirt infrastructure provider. properties: apiServerInternalIP: @@ -1762,17 +1762,17 @@ spec: type: string type: object powervs: - description: PowerVS contains settings specific to the Power Systems + description: powervs contains settings specific to the Power Systems Virtual Servers infrastructure provider. properties: cisInstanceCRN: description: |- - CISInstanceCRN is the CRN of the Cloud Internet Services instance managing + 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 + dnsInstanceCRN is the CRN of the DNS Services instance managing the DNS zone for the cluster's base domain type: string region: @@ -1882,7 +1882,7 @@ spec: - External type: string vsphere: - description: VSphere contains settings specific to the VSphere + description: vsphere contains settings specific to the VSphere infrastructure provider. properties: apiServerInternalIP: diff --git a/config/v1/zz_generated.featuregated-crd-manifests/infrastructures.config.openshift.io/AWSClusterHostedDNS.yaml b/config/v1/zz_generated.featuregated-crd-manifests/infrastructures.config.openshift.io/AWSClusterHostedDNS.yaml index e7d5fc2f30e..dba1c4e264c 100644 --- a/config/v1/zz_generated.featuregated-crd-manifests/infrastructures.config.openshift.io/AWSClusterHostedDNS.yaml +++ b/config/v1/zz_generated.featuregated-crd-manifests/infrastructures.config.openshift.io/AWSClusterHostedDNS.yaml @@ -62,7 +62,7 @@ spec: All the clients are expected to use the generated ConfigMap only. properties: key: - description: Key allows pointing to a specific key/value inside + description: key allows pointing to a specific key/value inside of the configmap. This is useful for logical file references. type: string name: @@ -74,11 +74,11 @@ spec: infrastructure provider. properties: alibabaCloud: - description: AlibabaCloud contains settings specific to the Alibaba + description: alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. type: object aws: - description: AWS contains settings specific to the Amazon Web + description: aws contains settings specific to the Amazon Web Services infrastructure provider. properties: serviceEndpoints: @@ -110,11 +110,11 @@ spec: x-kubernetes-list-type: atomic type: object azure: - description: Azure contains settings specific to the Azure infrastructure + description: azure contains settings specific to the Azure infrastructure provider. type: object baremetal: - description: BareMetal contains settings specific to the BareMetal + description: baremetal contains settings specific to the BareMetal platform. properties: apiServerInternalIPs: @@ -198,7 +198,7 @@ spec: - message: ingressIPs list is required once set rule: '!has(oldSelf.ingressIPs) || has(self.ingressIPs)' equinixMetal: - description: EquinixMetal contains settings specific to the Equinix + description: equinixMetal contains settings specific to the Equinix Metal infrastructure provider. type: object external: @@ -209,7 +209,7 @@ spec: platformName: default: Unknown description: |- - PlatformName holds the arbitrary string representing the infrastructure provider name, expected to be set at the installation time. + 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 x-kubernetes-validations: @@ -217,19 +217,19 @@ spec: rule: oldSelf == 'Unknown' || self == oldSelf type: object gcp: - description: GCP contains settings specific to the Google Cloud + description: gcp contains settings specific to the Google Cloud Platform infrastructure provider. type: object ibmcloud: - description: IBMCloud contains settings specific to the IBMCloud + description: ibmcloud contains settings specific to the IBMCloud infrastructure provider. type: object kubevirt: - description: Kubevirt contains settings specific to the kubevirt + description: kubevirt contains settings specific to the kubevirt infrastructure provider. type: object nutanix: - description: Nutanix contains settings specific to the Nutanix + description: nutanix contains settings specific to the Nutanix infrastructure provider. properties: failureDomains: @@ -414,7 +414,7 @@ spec: - prismElements type: object openstack: - description: OpenStack contains settings specific to the OpenStack + description: openstack contains settings specific to the OpenStack infrastructure provider. properties: apiServerInternalIPs: @@ -498,11 +498,11 @@ spec: - message: ingressIPs list is required once set rule: '!has(oldSelf.ingressIPs) || has(self.ingressIPs)' ovirt: - description: Ovirt contains settings specific to the oVirt infrastructure + description: ovirt contains settings specific to the oVirt infrastructure provider. type: object powervs: - description: PowerVS contains settings specific to the IBM Power + description: powervs contains settings specific to the IBM Power Systems Virtual Servers infrastructure provider. properties: serviceEndpoints: @@ -584,7 +584,7 @@ spec: - External type: string vsphere: - description: VSphere contains settings specific to the VSphere + description: vsphere contains settings specific to the VSphere infrastructure provider. properties: apiServerInternalIPs: @@ -665,7 +665,7 @@ spec: minLength: 1 type: string topology: - description: Topology describes a given failure domain + description: topology describes a given failure domain using vSphere constructs properties: computeCluster: @@ -1094,7 +1094,7 @@ spec: infrastructure provider. properties: alibabaCloud: - description: AlibabaCloud contains settings specific to the Alibaba + description: alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. properties: region: @@ -1137,7 +1137,7 @@ spec: - region type: object aws: - description: AWS contains settings specific to the Amazon Web + description: aws contains settings specific to the Amazon Web Services infrastructure provider. properties: cloudLoadBalancerConfig: @@ -1282,7 +1282,7 @@ spec: x-kubernetes-list-type: atomic serviceEndpoints: description: |- - ServiceEndpoints list contains custom endpoints which will override default + serviceEndpoints list contains custom endpoints which will override default service endpoint of AWS Services. There must be only one ServiceEndpoint for a service. items: @@ -1309,7 +1309,7 @@ spec: x-kubernetes-list-type: atomic type: object azure: - description: Azure contains settings specific to the Azure infrastructure + description: azure contains settings specific to the Azure infrastructure provider. properties: armEndpoint: @@ -1382,7 +1382,7 @@ spec: rule: '!has(oldSelf.resourceTags) && !has(self.resourceTags) || has(oldSelf.resourceTags) && has(self.resourceTags)' baremetal: - description: BareMetal contains settings specific to the BareMetal + description: baremetal contains settings specific to the BareMetal platform. properties: apiServerInternalIP: @@ -1466,7 +1466,7 @@ spec: type: string type: object equinixMetal: - description: EquinixMetal contains settings specific to the Equinix + description: equinixMetal contains settings specific to the Equinix Metal infrastructure provider. properties: apiServerInternalIP: @@ -1483,7 +1483,7 @@ spec: type: string type: object external: - description: External contains settings specific to the generic + description: external contains settings specific to the generic External infrastructure provider. properties: cloudControllerManager: @@ -1522,7 +1522,7 @@ spec: once set rule: has(self.cloudControllerManager) == has(oldSelf.cloudControllerManager) gcp: - description: GCP contains settings specific to the Google Cloud + description: gcp contains settings specific to the Google Cloud Platform infrastructure provider. properties: projectID: @@ -1535,28 +1535,28 @@ spec: type: string type: object ibmcloud: - description: IBMCloud contains settings specific to the IBMCloud + description: ibmcloud contains settings specific to the IBMCloud infrastructure provider. properties: cisInstanceCRN: description: |- - CISInstanceCRN is the CRN of the Cloud Internet Services instance managing + 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 + 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 + description: location is where the cluster has been deployed type: string providerType: - description: ProviderType indicates the type of cluster that + description: providerType indicates the type of cluster that was created type: string resourceGroupName: - description: ResourceGroupName is the Resource Group for new + description: resourceGroupName is the Resource Group for new IBMCloud resources created for the cluster. type: string serviceEndpoints: @@ -1611,7 +1611,7 @@ spec: x-kubernetes-list-type: map type: object kubevirt: - description: Kubevirt contains settings specific to the kubevirt + description: kubevirt contains settings specific to the kubevirt infrastructure provider. properties: apiServerInternalIP: @@ -1628,7 +1628,7 @@ spec: type: string type: object nutanix: - description: Nutanix contains settings specific to the Nutanix + description: nutanix contains settings specific to the Nutanix infrastructure provider. properties: apiServerInternalIP: @@ -1686,7 +1686,7 @@ spec: : true)' type: object openstack: - description: OpenStack contains settings specific to the OpenStack + description: openstack contains settings specific to the OpenStack infrastructure provider. properties: apiServerInternalIP: @@ -1801,7 +1801,7 @@ spec: type: string type: object ovirt: - description: Ovirt contains settings specific to the oVirt infrastructure + description: ovirt contains settings specific to the oVirt infrastructure provider. properties: apiServerInternalIP: @@ -1863,17 +1863,17 @@ spec: type: string type: object powervs: - description: PowerVS contains settings specific to the Power Systems + description: powervs contains settings specific to the Power Systems Virtual Servers infrastructure provider. properties: cisInstanceCRN: description: |- - CISInstanceCRN is the CRN of the Cloud Internet Services instance managing + 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 + dnsInstanceCRN is the CRN of the DNS Services instance managing the DNS zone for the cluster's base domain type: string region: @@ -1983,7 +1983,7 @@ spec: - External type: string vsphere: - description: VSphere contains settings specific to the VSphere + description: vsphere contains settings specific to the VSphere infrastructure provider. properties: apiServerInternalIP: diff --git a/config/v1/zz_generated.featuregated-crd-manifests/infrastructures.config.openshift.io/BareMetalLoadBalancer.yaml b/config/v1/zz_generated.featuregated-crd-manifests/infrastructures.config.openshift.io/BareMetalLoadBalancer.yaml index a322908ffaf..3ce5270185e 100644 --- a/config/v1/zz_generated.featuregated-crd-manifests/infrastructures.config.openshift.io/BareMetalLoadBalancer.yaml +++ b/config/v1/zz_generated.featuregated-crd-manifests/infrastructures.config.openshift.io/BareMetalLoadBalancer.yaml @@ -62,7 +62,7 @@ spec: All the clients are expected to use the generated ConfigMap only. properties: key: - description: Key allows pointing to a specific key/value inside + description: key allows pointing to a specific key/value inside of the configmap. This is useful for logical file references. type: string name: @@ -74,11 +74,11 @@ spec: infrastructure provider. properties: alibabaCloud: - description: AlibabaCloud contains settings specific to the Alibaba + description: alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. type: object aws: - description: AWS contains settings specific to the Amazon Web + description: aws contains settings specific to the Amazon Web Services infrastructure provider. properties: serviceEndpoints: @@ -110,11 +110,11 @@ spec: x-kubernetes-list-type: atomic type: object azure: - description: Azure contains settings specific to the Azure infrastructure + description: azure contains settings specific to the Azure infrastructure provider. type: object baremetal: - description: BareMetal contains settings specific to the BareMetal + description: baremetal contains settings specific to the BareMetal platform. properties: apiServerInternalIPs: @@ -198,7 +198,7 @@ spec: - message: ingressIPs list is required once set rule: '!has(oldSelf.ingressIPs) || has(self.ingressIPs)' equinixMetal: - description: EquinixMetal contains settings specific to the Equinix + description: equinixMetal contains settings specific to the Equinix Metal infrastructure provider. type: object external: @@ -209,7 +209,7 @@ spec: platformName: default: Unknown description: |- - PlatformName holds the arbitrary string representing the infrastructure provider name, expected to be set at the installation time. + 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 x-kubernetes-validations: @@ -217,19 +217,19 @@ spec: rule: oldSelf == 'Unknown' || self == oldSelf type: object gcp: - description: GCP contains settings specific to the Google Cloud + description: gcp contains settings specific to the Google Cloud Platform infrastructure provider. type: object ibmcloud: - description: IBMCloud contains settings specific to the IBMCloud + description: ibmcloud contains settings specific to the IBMCloud infrastructure provider. type: object kubevirt: - description: Kubevirt contains settings specific to the kubevirt + description: kubevirt contains settings specific to the kubevirt infrastructure provider. type: object nutanix: - description: Nutanix contains settings specific to the Nutanix + description: nutanix contains settings specific to the Nutanix infrastructure provider. properties: failureDomains: @@ -414,7 +414,7 @@ spec: - prismElements type: object openstack: - description: OpenStack contains settings specific to the OpenStack + description: openstack contains settings specific to the OpenStack infrastructure provider. properties: apiServerInternalIPs: @@ -498,11 +498,11 @@ spec: - message: ingressIPs list is required once set rule: '!has(oldSelf.ingressIPs) || has(self.ingressIPs)' ovirt: - description: Ovirt contains settings specific to the oVirt infrastructure + description: ovirt contains settings specific to the oVirt infrastructure provider. type: object powervs: - description: PowerVS contains settings specific to the IBM Power + description: powervs contains settings specific to the IBM Power Systems Virtual Servers infrastructure provider. properties: serviceEndpoints: @@ -584,7 +584,7 @@ spec: - External type: string vsphere: - description: VSphere contains settings specific to the VSphere + description: vsphere contains settings specific to the VSphere infrastructure provider. properties: apiServerInternalIPs: @@ -665,7 +665,7 @@ spec: minLength: 1 type: string topology: - description: Topology describes a given failure domain + description: topology describes a given failure domain using vSphere constructs properties: computeCluster: @@ -1094,7 +1094,7 @@ spec: infrastructure provider. properties: alibabaCloud: - description: AlibabaCloud contains settings specific to the Alibaba + description: alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. properties: region: @@ -1137,7 +1137,7 @@ spec: - region type: object aws: - description: AWS contains settings specific to the Amazon Web + description: aws contains settings specific to the Amazon Web Services infrastructure provider. properties: region: @@ -1178,7 +1178,7 @@ spec: x-kubernetes-list-type: atomic serviceEndpoints: description: |- - ServiceEndpoints list contains custom endpoints which will override default + serviceEndpoints list contains custom endpoints which will override default service endpoint of AWS Services. There must be only one ServiceEndpoint for a service. items: @@ -1205,7 +1205,7 @@ spec: x-kubernetes-list-type: atomic type: object azure: - description: Azure contains settings specific to the Azure infrastructure + description: azure contains settings specific to the Azure infrastructure provider. properties: armEndpoint: @@ -1278,7 +1278,7 @@ spec: rule: '!has(oldSelf.resourceTags) && !has(self.resourceTags) || has(oldSelf.resourceTags) && has(self.resourceTags)' baremetal: - description: BareMetal contains settings specific to the BareMetal + description: baremetal contains settings specific to the BareMetal platform. properties: apiServerInternalIP: @@ -1388,7 +1388,7 @@ spec: type: string type: object equinixMetal: - description: EquinixMetal contains settings specific to the Equinix + description: equinixMetal contains settings specific to the Equinix Metal infrastructure provider. properties: apiServerInternalIP: @@ -1405,7 +1405,7 @@ spec: type: string type: object external: - description: External contains settings specific to the generic + description: external contains settings specific to the generic External infrastructure provider. properties: cloudControllerManager: @@ -1444,7 +1444,7 @@ spec: once set rule: has(self.cloudControllerManager) == has(oldSelf.cloudControllerManager) gcp: - description: GCP contains settings specific to the Google Cloud + description: gcp contains settings specific to the Google Cloud Platform infrastructure provider. properties: projectID: @@ -1457,28 +1457,28 @@ spec: type: string type: object ibmcloud: - description: IBMCloud contains settings specific to the IBMCloud + description: ibmcloud contains settings specific to the IBMCloud infrastructure provider. properties: cisInstanceCRN: description: |- - CISInstanceCRN is the CRN of the Cloud Internet Services instance managing + 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 + 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 + description: location is where the cluster has been deployed type: string providerType: - description: ProviderType indicates the type of cluster that + description: providerType indicates the type of cluster that was created type: string resourceGroupName: - description: ResourceGroupName is the Resource Group for new + description: resourceGroupName is the Resource Group for new IBMCloud resources created for the cluster. type: string serviceEndpoints: @@ -1533,7 +1533,7 @@ spec: x-kubernetes-list-type: map type: object kubevirt: - description: Kubevirt contains settings specific to the kubevirt + description: kubevirt contains settings specific to the kubevirt infrastructure provider. properties: apiServerInternalIP: @@ -1550,7 +1550,7 @@ spec: type: string type: object nutanix: - description: Nutanix contains settings specific to the Nutanix + description: nutanix contains settings specific to the Nutanix infrastructure provider. properties: apiServerInternalIP: @@ -1634,7 +1634,7 @@ spec: type: object type: object openstack: - description: OpenStack contains settings specific to the OpenStack + description: openstack contains settings specific to the OpenStack infrastructure provider. properties: apiServerInternalIP: @@ -1749,7 +1749,7 @@ spec: type: string type: object ovirt: - description: Ovirt contains settings specific to the oVirt infrastructure + description: ovirt contains settings specific to the oVirt infrastructure provider. properties: apiServerInternalIP: @@ -1837,17 +1837,17 @@ spec: type: string type: object powervs: - description: PowerVS contains settings specific to the Power Systems + description: powervs contains settings specific to the Power Systems Virtual Servers infrastructure provider. properties: cisInstanceCRN: description: |- - CISInstanceCRN is the CRN of the Cloud Internet Services instance managing + 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 + dnsInstanceCRN is the CRN of the DNS Services instance managing the DNS zone for the cluster's base domain type: string region: @@ -1957,7 +1957,7 @@ spec: - External type: string vsphere: - description: VSphere contains settings specific to the VSphere + description: vsphere contains settings specific to the VSphere infrastructure provider. properties: apiServerInternalIP: diff --git a/config/v1/zz_generated.featuregated-crd-manifests/infrastructures.config.openshift.io/GCPClusterHostedDNS.yaml b/config/v1/zz_generated.featuregated-crd-manifests/infrastructures.config.openshift.io/GCPClusterHostedDNS.yaml index a26f0f7edce..f2d09287e44 100644 --- a/config/v1/zz_generated.featuregated-crd-manifests/infrastructures.config.openshift.io/GCPClusterHostedDNS.yaml +++ b/config/v1/zz_generated.featuregated-crd-manifests/infrastructures.config.openshift.io/GCPClusterHostedDNS.yaml @@ -62,7 +62,7 @@ spec: All the clients are expected to use the generated ConfigMap only. properties: key: - description: Key allows pointing to a specific key/value inside + description: key allows pointing to a specific key/value inside of the configmap. This is useful for logical file references. type: string name: @@ -74,11 +74,11 @@ spec: infrastructure provider. properties: alibabaCloud: - description: AlibabaCloud contains settings specific to the Alibaba + description: alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. type: object aws: - description: AWS contains settings specific to the Amazon Web + description: aws contains settings specific to the Amazon Web Services infrastructure provider. properties: serviceEndpoints: @@ -110,11 +110,11 @@ spec: x-kubernetes-list-type: atomic type: object azure: - description: Azure contains settings specific to the Azure infrastructure + description: azure contains settings specific to the Azure infrastructure provider. type: object baremetal: - description: BareMetal contains settings specific to the BareMetal + description: baremetal contains settings specific to the BareMetal platform. properties: apiServerInternalIPs: @@ -198,7 +198,7 @@ spec: - message: ingressIPs list is required once set rule: '!has(oldSelf.ingressIPs) || has(self.ingressIPs)' equinixMetal: - description: EquinixMetal contains settings specific to the Equinix + description: equinixMetal contains settings specific to the Equinix Metal infrastructure provider. type: object external: @@ -209,7 +209,7 @@ spec: platformName: default: Unknown description: |- - PlatformName holds the arbitrary string representing the infrastructure provider name, expected to be set at the installation time. + 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 x-kubernetes-validations: @@ -217,19 +217,19 @@ spec: rule: oldSelf == 'Unknown' || self == oldSelf type: object gcp: - description: GCP contains settings specific to the Google Cloud + description: gcp contains settings specific to the Google Cloud Platform infrastructure provider. type: object ibmcloud: - description: IBMCloud contains settings specific to the IBMCloud + description: ibmcloud contains settings specific to the IBMCloud infrastructure provider. type: object kubevirt: - description: Kubevirt contains settings specific to the kubevirt + description: kubevirt contains settings specific to the kubevirt infrastructure provider. type: object nutanix: - description: Nutanix contains settings specific to the Nutanix + description: nutanix contains settings specific to the Nutanix infrastructure provider. properties: failureDomains: @@ -414,7 +414,7 @@ spec: - prismElements type: object openstack: - description: OpenStack contains settings specific to the OpenStack + description: openstack contains settings specific to the OpenStack infrastructure provider. properties: apiServerInternalIPs: @@ -498,11 +498,11 @@ spec: - message: ingressIPs list is required once set rule: '!has(oldSelf.ingressIPs) || has(self.ingressIPs)' ovirt: - description: Ovirt contains settings specific to the oVirt infrastructure + description: ovirt contains settings specific to the oVirt infrastructure provider. type: object powervs: - description: PowerVS contains settings specific to the IBM Power + description: powervs contains settings specific to the IBM Power Systems Virtual Servers infrastructure provider. properties: serviceEndpoints: @@ -584,7 +584,7 @@ spec: - External type: string vsphere: - description: VSphere contains settings specific to the VSphere + description: vsphere contains settings specific to the VSphere infrastructure provider. properties: apiServerInternalIPs: @@ -665,7 +665,7 @@ spec: minLength: 1 type: string topology: - description: Topology describes a given failure domain + description: topology describes a given failure domain using vSphere constructs properties: computeCluster: @@ -1094,7 +1094,7 @@ spec: infrastructure provider. properties: alibabaCloud: - description: AlibabaCloud contains settings specific to the Alibaba + description: alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. properties: region: @@ -1137,7 +1137,7 @@ spec: - region type: object aws: - description: AWS contains settings specific to the Amazon Web + description: aws contains settings specific to the Amazon Web Services infrastructure provider. properties: region: @@ -1178,7 +1178,7 @@ spec: x-kubernetes-list-type: atomic serviceEndpoints: description: |- - ServiceEndpoints list contains custom endpoints which will override default + serviceEndpoints list contains custom endpoints which will override default service endpoint of AWS Services. There must be only one ServiceEndpoint for a service. items: @@ -1205,7 +1205,7 @@ spec: x-kubernetes-list-type: atomic type: object azure: - description: Azure contains settings specific to the Azure infrastructure + description: azure contains settings specific to the Azure infrastructure provider. properties: armEndpoint: @@ -1278,7 +1278,7 @@ spec: rule: '!has(oldSelf.resourceTags) && !has(self.resourceTags) || has(oldSelf.resourceTags) && has(self.resourceTags)' baremetal: - description: BareMetal contains settings specific to the BareMetal + description: baremetal contains settings specific to the BareMetal platform. properties: apiServerInternalIP: @@ -1362,7 +1362,7 @@ spec: type: string type: object equinixMetal: - description: EquinixMetal contains settings specific to the Equinix + description: equinixMetal contains settings specific to the Equinix Metal infrastructure provider. properties: apiServerInternalIP: @@ -1379,7 +1379,7 @@ spec: type: string type: object external: - description: External contains settings specific to the generic + description: external contains settings specific to the generic External infrastructure provider. properties: cloudControllerManager: @@ -1418,7 +1418,7 @@ spec: once set rule: has(self.cloudControllerManager) == has(oldSelf.cloudControllerManager) gcp: - description: GCP contains settings specific to the Google Cloud + description: gcp contains settings specific to the Google Cloud Platform infrastructure provider. properties: cloudLoadBalancerConfig: @@ -1535,28 +1535,28 @@ spec: type: string type: object ibmcloud: - description: IBMCloud contains settings specific to the IBMCloud + description: ibmcloud contains settings specific to the IBMCloud infrastructure provider. properties: cisInstanceCRN: description: |- - CISInstanceCRN is the CRN of the Cloud Internet Services instance managing + 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 + 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 + description: location is where the cluster has been deployed type: string providerType: - description: ProviderType indicates the type of cluster that + description: providerType indicates the type of cluster that was created type: string resourceGroupName: - description: ResourceGroupName is the Resource Group for new + description: resourceGroupName is the Resource Group for new IBMCloud resources created for the cluster. type: string serviceEndpoints: @@ -1611,7 +1611,7 @@ spec: x-kubernetes-list-type: map type: object kubevirt: - description: Kubevirt contains settings specific to the kubevirt + description: kubevirt contains settings specific to the kubevirt infrastructure provider. properties: apiServerInternalIP: @@ -1628,7 +1628,7 @@ spec: type: string type: object nutanix: - description: Nutanix contains settings specific to the Nutanix + description: nutanix contains settings specific to the Nutanix infrastructure provider. properties: apiServerInternalIP: @@ -1686,7 +1686,7 @@ spec: : true)' type: object openstack: - description: OpenStack contains settings specific to the OpenStack + description: openstack contains settings specific to the OpenStack infrastructure provider. properties: apiServerInternalIP: @@ -1801,7 +1801,7 @@ spec: type: string type: object ovirt: - description: Ovirt contains settings specific to the oVirt infrastructure + description: ovirt contains settings specific to the oVirt infrastructure provider. properties: apiServerInternalIP: @@ -1863,17 +1863,17 @@ spec: type: string type: object powervs: - description: PowerVS contains settings specific to the Power Systems + description: powervs contains settings specific to the Power Systems Virtual Servers infrastructure provider. properties: cisInstanceCRN: description: |- - CISInstanceCRN is the CRN of the Cloud Internet Services instance managing + 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 + dnsInstanceCRN is the CRN of the DNS Services instance managing the DNS zone for the cluster's base domain type: string region: @@ -1983,7 +1983,7 @@ spec: - External type: string vsphere: - description: VSphere contains settings specific to the VSphere + description: vsphere contains settings specific to the VSphere infrastructure provider. properties: apiServerInternalIP: diff --git a/config/v1/zz_generated.featuregated-crd-manifests/infrastructures.config.openshift.io/GCPLabelsTags.yaml b/config/v1/zz_generated.featuregated-crd-manifests/infrastructures.config.openshift.io/GCPLabelsTags.yaml index f5aea3e8cd9..2e709a12f89 100644 --- a/config/v1/zz_generated.featuregated-crd-manifests/infrastructures.config.openshift.io/GCPLabelsTags.yaml +++ b/config/v1/zz_generated.featuregated-crd-manifests/infrastructures.config.openshift.io/GCPLabelsTags.yaml @@ -62,7 +62,7 @@ spec: All the clients are expected to use the generated ConfigMap only. properties: key: - description: Key allows pointing to a specific key/value inside + description: key allows pointing to a specific key/value inside of the configmap. This is useful for logical file references. type: string name: @@ -74,11 +74,11 @@ spec: infrastructure provider. properties: alibabaCloud: - description: AlibabaCloud contains settings specific to the Alibaba + description: alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. type: object aws: - description: AWS contains settings specific to the Amazon Web + description: aws contains settings specific to the Amazon Web Services infrastructure provider. properties: serviceEndpoints: @@ -110,11 +110,11 @@ spec: x-kubernetes-list-type: atomic type: object azure: - description: Azure contains settings specific to the Azure infrastructure + description: azure contains settings specific to the Azure infrastructure provider. type: object baremetal: - description: BareMetal contains settings specific to the BareMetal + description: baremetal contains settings specific to the BareMetal platform. properties: apiServerInternalIPs: @@ -198,7 +198,7 @@ spec: - message: ingressIPs list is required once set rule: '!has(oldSelf.ingressIPs) || has(self.ingressIPs)' equinixMetal: - description: EquinixMetal contains settings specific to the Equinix + description: equinixMetal contains settings specific to the Equinix Metal infrastructure provider. type: object external: @@ -209,7 +209,7 @@ spec: platformName: default: Unknown description: |- - PlatformName holds the arbitrary string representing the infrastructure provider name, expected to be set at the installation time. + 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 x-kubernetes-validations: @@ -217,19 +217,19 @@ spec: rule: oldSelf == 'Unknown' || self == oldSelf type: object gcp: - description: GCP contains settings specific to the Google Cloud + description: gcp contains settings specific to the Google Cloud Platform infrastructure provider. type: object ibmcloud: - description: IBMCloud contains settings specific to the IBMCloud + description: ibmcloud contains settings specific to the IBMCloud infrastructure provider. type: object kubevirt: - description: Kubevirt contains settings specific to the kubevirt + description: kubevirt contains settings specific to the kubevirt infrastructure provider. type: object nutanix: - description: Nutanix contains settings specific to the Nutanix + description: nutanix contains settings specific to the Nutanix infrastructure provider. properties: failureDomains: @@ -414,7 +414,7 @@ spec: - prismElements type: object openstack: - description: OpenStack contains settings specific to the OpenStack + description: openstack contains settings specific to the OpenStack infrastructure provider. properties: apiServerInternalIPs: @@ -498,11 +498,11 @@ spec: - message: ingressIPs list is required once set rule: '!has(oldSelf.ingressIPs) || has(self.ingressIPs)' ovirt: - description: Ovirt contains settings specific to the oVirt infrastructure + description: ovirt contains settings specific to the oVirt infrastructure provider. type: object powervs: - description: PowerVS contains settings specific to the IBM Power + description: powervs contains settings specific to the IBM Power Systems Virtual Servers infrastructure provider. properties: serviceEndpoints: @@ -584,7 +584,7 @@ spec: - External type: string vsphere: - description: VSphere contains settings specific to the VSphere + description: vsphere contains settings specific to the VSphere infrastructure provider. properties: apiServerInternalIPs: @@ -665,7 +665,7 @@ spec: minLength: 1 type: string topology: - description: Topology describes a given failure domain + description: topology describes a given failure domain using vSphere constructs properties: computeCluster: @@ -1094,7 +1094,7 @@ spec: infrastructure provider. properties: alibabaCloud: - description: AlibabaCloud contains settings specific to the Alibaba + description: alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. properties: region: @@ -1137,7 +1137,7 @@ spec: - region type: object aws: - description: AWS contains settings specific to the Amazon Web + description: aws contains settings specific to the Amazon Web Services infrastructure provider. properties: region: @@ -1178,7 +1178,7 @@ spec: x-kubernetes-list-type: atomic serviceEndpoints: description: |- - ServiceEndpoints list contains custom endpoints which will override default + serviceEndpoints list contains custom endpoints which will override default service endpoint of AWS Services. There must be only one ServiceEndpoint for a service. items: @@ -1205,7 +1205,7 @@ spec: x-kubernetes-list-type: atomic type: object azure: - description: Azure contains settings specific to the Azure infrastructure + description: azure contains settings specific to the Azure infrastructure provider. properties: armEndpoint: @@ -1278,7 +1278,7 @@ spec: rule: '!has(oldSelf.resourceTags) && !has(self.resourceTags) || has(oldSelf.resourceTags) && has(self.resourceTags)' baremetal: - description: BareMetal contains settings specific to the BareMetal + description: baremetal contains settings specific to the BareMetal platform. properties: apiServerInternalIP: @@ -1362,7 +1362,7 @@ spec: type: string type: object equinixMetal: - description: EquinixMetal contains settings specific to the Equinix + description: equinixMetal contains settings specific to the Equinix Metal infrastructure provider. properties: apiServerInternalIP: @@ -1379,7 +1379,7 @@ spec: type: string type: object external: - description: External contains settings specific to the generic + description: external contains settings specific to the generic External infrastructure provider. properties: cloudControllerManager: @@ -1418,7 +1418,7 @@ spec: once set rule: has(self.cloudControllerManager) == has(oldSelf.cloudControllerManager) gcp: - description: GCP contains settings specific to the Google Cloud + description: gcp contains settings specific to the Google Cloud Platform infrastructure provider. properties: projectID: @@ -1537,28 +1537,28 @@ spec: rule: '!has(oldSelf.resourceTags) && !has(self.resourceTags) || has(oldSelf.resourceTags) && has(self.resourceTags)' ibmcloud: - description: IBMCloud contains settings specific to the IBMCloud + description: ibmcloud contains settings specific to the IBMCloud infrastructure provider. properties: cisInstanceCRN: description: |- - CISInstanceCRN is the CRN of the Cloud Internet Services instance managing + 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 + 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 + description: location is where the cluster has been deployed type: string providerType: - description: ProviderType indicates the type of cluster that + description: providerType indicates the type of cluster that was created type: string resourceGroupName: - description: ResourceGroupName is the Resource Group for new + description: resourceGroupName is the Resource Group for new IBMCloud resources created for the cluster. type: string serviceEndpoints: @@ -1613,7 +1613,7 @@ spec: x-kubernetes-list-type: map type: object kubevirt: - description: Kubevirt contains settings specific to the kubevirt + description: kubevirt contains settings specific to the kubevirt infrastructure provider. properties: apiServerInternalIP: @@ -1630,7 +1630,7 @@ spec: type: string type: object nutanix: - description: Nutanix contains settings specific to the Nutanix + description: nutanix contains settings specific to the Nutanix infrastructure provider. properties: apiServerInternalIP: @@ -1688,7 +1688,7 @@ spec: : true)' type: object openstack: - description: OpenStack contains settings specific to the OpenStack + description: openstack contains settings specific to the OpenStack infrastructure provider. properties: apiServerInternalIP: @@ -1803,7 +1803,7 @@ spec: type: string type: object ovirt: - description: Ovirt contains settings specific to the oVirt infrastructure + description: ovirt contains settings specific to the oVirt infrastructure provider. properties: apiServerInternalIP: @@ -1865,17 +1865,17 @@ spec: type: string type: object powervs: - description: PowerVS contains settings specific to the Power Systems + description: powervs contains settings specific to the Power Systems Virtual Servers infrastructure provider. properties: cisInstanceCRN: description: |- - CISInstanceCRN is the CRN of the Cloud Internet Services instance managing + 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 + dnsInstanceCRN is the CRN of the DNS Services instance managing the DNS zone for the cluster's base domain type: string region: @@ -1985,7 +1985,7 @@ spec: - External type: string vsphere: - description: VSphere contains settings specific to the VSphere + description: vsphere contains settings specific to the VSphere infrastructure provider. properties: apiServerInternalIP: diff --git a/config/v1/zz_generated.featuregated-crd-manifests/infrastructures.config.openshift.io/VSphereControlPlaneMachineSet.yaml b/config/v1/zz_generated.featuregated-crd-manifests/infrastructures.config.openshift.io/VSphereControlPlaneMachineSet.yaml index 379dbecbf1b..15bcc8a517b 100644 --- a/config/v1/zz_generated.featuregated-crd-manifests/infrastructures.config.openshift.io/VSphereControlPlaneMachineSet.yaml +++ b/config/v1/zz_generated.featuregated-crd-manifests/infrastructures.config.openshift.io/VSphereControlPlaneMachineSet.yaml @@ -62,7 +62,7 @@ spec: All the clients are expected to use the generated ConfigMap only. properties: key: - description: Key allows pointing to a specific key/value inside + description: key allows pointing to a specific key/value inside of the configmap. This is useful for logical file references. type: string name: @@ -74,11 +74,11 @@ spec: infrastructure provider. properties: alibabaCloud: - description: AlibabaCloud contains settings specific to the Alibaba + description: alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. type: object aws: - description: AWS contains settings specific to the Amazon Web + description: aws contains settings specific to the Amazon Web Services infrastructure provider. properties: serviceEndpoints: @@ -110,11 +110,11 @@ spec: x-kubernetes-list-type: atomic type: object azure: - description: Azure contains settings specific to the Azure infrastructure + description: azure contains settings specific to the Azure infrastructure provider. type: object baremetal: - description: BareMetal contains settings specific to the BareMetal + description: baremetal contains settings specific to the BareMetal platform. properties: apiServerInternalIPs: @@ -198,7 +198,7 @@ spec: - message: ingressIPs list is required once set rule: '!has(oldSelf.ingressIPs) || has(self.ingressIPs)' equinixMetal: - description: EquinixMetal contains settings specific to the Equinix + description: equinixMetal contains settings specific to the Equinix Metal infrastructure provider. type: object external: @@ -209,7 +209,7 @@ spec: platformName: default: Unknown description: |- - PlatformName holds the arbitrary string representing the infrastructure provider name, expected to be set at the installation time. + 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 x-kubernetes-validations: @@ -217,19 +217,19 @@ spec: rule: oldSelf == 'Unknown' || self == oldSelf type: object gcp: - description: GCP contains settings specific to the Google Cloud + description: gcp contains settings specific to the Google Cloud Platform infrastructure provider. type: object ibmcloud: - description: IBMCloud contains settings specific to the IBMCloud + description: ibmcloud contains settings specific to the IBMCloud infrastructure provider. type: object kubevirt: - description: Kubevirt contains settings specific to the kubevirt + description: kubevirt contains settings specific to the kubevirt infrastructure provider. type: object nutanix: - description: Nutanix contains settings specific to the Nutanix + description: nutanix contains settings specific to the Nutanix infrastructure provider. properties: failureDomains: @@ -414,7 +414,7 @@ spec: - prismElements type: object openstack: - description: OpenStack contains settings specific to the OpenStack + description: openstack contains settings specific to the OpenStack infrastructure provider. properties: apiServerInternalIPs: @@ -498,11 +498,11 @@ spec: - message: ingressIPs list is required once set rule: '!has(oldSelf.ingressIPs) || has(self.ingressIPs)' ovirt: - description: Ovirt contains settings specific to the oVirt infrastructure + description: ovirt contains settings specific to the oVirt infrastructure provider. type: object powervs: - description: PowerVS contains settings specific to the IBM Power + description: powervs contains settings specific to the IBM Power Systems Virtual Servers infrastructure provider. properties: serviceEndpoints: @@ -584,7 +584,7 @@ spec: - External type: string vsphere: - description: VSphere contains settings specific to the VSphere + description: vsphere contains settings specific to the VSphere infrastructure provider. properties: apiServerInternalIPs: @@ -665,7 +665,7 @@ spec: minLength: 1 type: string topology: - description: Topology describes a given failure domain + description: topology describes a given failure domain using vSphere constructs properties: computeCluster: @@ -1109,7 +1109,7 @@ spec: infrastructure provider. properties: alibabaCloud: - description: AlibabaCloud contains settings specific to the Alibaba + description: alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. properties: region: @@ -1152,7 +1152,7 @@ spec: - region type: object aws: - description: AWS contains settings specific to the Amazon Web + description: aws contains settings specific to the Amazon Web Services infrastructure provider. properties: region: @@ -1193,7 +1193,7 @@ spec: x-kubernetes-list-type: atomic serviceEndpoints: description: |- - ServiceEndpoints list contains custom endpoints which will override default + serviceEndpoints list contains custom endpoints which will override default service endpoint of AWS Services. There must be only one ServiceEndpoint for a service. items: @@ -1220,7 +1220,7 @@ spec: x-kubernetes-list-type: atomic type: object azure: - description: Azure contains settings specific to the Azure infrastructure + description: azure contains settings specific to the Azure infrastructure provider. properties: armEndpoint: @@ -1293,7 +1293,7 @@ spec: rule: '!has(oldSelf.resourceTags) && !has(self.resourceTags) || has(oldSelf.resourceTags) && has(self.resourceTags)' baremetal: - description: BareMetal contains settings specific to the BareMetal + description: baremetal contains settings specific to the BareMetal platform. properties: apiServerInternalIP: @@ -1377,7 +1377,7 @@ spec: type: string type: object equinixMetal: - description: EquinixMetal contains settings specific to the Equinix + description: equinixMetal contains settings specific to the Equinix Metal infrastructure provider. properties: apiServerInternalIP: @@ -1394,7 +1394,7 @@ spec: type: string type: object external: - description: External contains settings specific to the generic + description: external contains settings specific to the generic External infrastructure provider. properties: cloudControllerManager: @@ -1433,7 +1433,7 @@ spec: once set rule: has(self.cloudControllerManager) == has(oldSelf.cloudControllerManager) gcp: - description: GCP contains settings specific to the Google Cloud + description: gcp contains settings specific to the Google Cloud Platform infrastructure provider. properties: projectID: @@ -1446,28 +1446,28 @@ spec: type: string type: object ibmcloud: - description: IBMCloud contains settings specific to the IBMCloud + description: ibmcloud contains settings specific to the IBMCloud infrastructure provider. properties: cisInstanceCRN: description: |- - CISInstanceCRN is the CRN of the Cloud Internet Services instance managing + 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 + 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 + description: location is where the cluster has been deployed type: string providerType: - description: ProviderType indicates the type of cluster that + description: providerType indicates the type of cluster that was created type: string resourceGroupName: - description: ResourceGroupName is the Resource Group for new + description: resourceGroupName is the Resource Group for new IBMCloud resources created for the cluster. type: string serviceEndpoints: @@ -1522,7 +1522,7 @@ spec: x-kubernetes-list-type: map type: object kubevirt: - description: Kubevirt contains settings specific to the kubevirt + description: kubevirt contains settings specific to the kubevirt infrastructure provider. properties: apiServerInternalIP: @@ -1539,7 +1539,7 @@ spec: type: string type: object nutanix: - description: Nutanix contains settings specific to the Nutanix + description: nutanix contains settings specific to the Nutanix infrastructure provider. properties: apiServerInternalIP: @@ -1597,7 +1597,7 @@ spec: : true)' type: object openstack: - description: OpenStack contains settings specific to the OpenStack + description: openstack contains settings specific to the OpenStack infrastructure provider. properties: apiServerInternalIP: @@ -1712,7 +1712,7 @@ spec: type: string type: object ovirt: - description: Ovirt contains settings specific to the oVirt infrastructure + description: ovirt contains settings specific to the oVirt infrastructure provider. properties: apiServerInternalIP: @@ -1774,17 +1774,17 @@ spec: type: string type: object powervs: - description: PowerVS contains settings specific to the Power Systems + description: powervs contains settings specific to the Power Systems Virtual Servers infrastructure provider. properties: cisInstanceCRN: description: |- - CISInstanceCRN is the CRN of the Cloud Internet Services instance managing + 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 + dnsInstanceCRN is the CRN of the DNS Services instance managing the DNS zone for the cluster's base domain type: string region: @@ -1894,7 +1894,7 @@ spec: - External type: string vsphere: - description: VSphere contains settings specific to the VSphere + description: vsphere contains settings specific to the VSphere infrastructure provider. properties: apiServerInternalIP: diff --git a/config/v1/zz_generated.featuregated-crd-manifests/infrastructures.config.openshift.io/VSphereMultiNetworks.yaml b/config/v1/zz_generated.featuregated-crd-manifests/infrastructures.config.openshift.io/VSphereMultiNetworks.yaml index 9f9d86e26f8..15603fec656 100644 --- a/config/v1/zz_generated.featuregated-crd-manifests/infrastructures.config.openshift.io/VSphereMultiNetworks.yaml +++ b/config/v1/zz_generated.featuregated-crd-manifests/infrastructures.config.openshift.io/VSphereMultiNetworks.yaml @@ -62,7 +62,7 @@ spec: All the clients are expected to use the generated ConfigMap only. properties: key: - description: Key allows pointing to a specific key/value inside + description: key allows pointing to a specific key/value inside of the configmap. This is useful for logical file references. type: string name: @@ -74,11 +74,11 @@ spec: infrastructure provider. properties: alibabaCloud: - description: AlibabaCloud contains settings specific to the Alibaba + description: alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. type: object aws: - description: AWS contains settings specific to the Amazon Web + description: aws contains settings specific to the Amazon Web Services infrastructure provider. properties: serviceEndpoints: @@ -110,11 +110,11 @@ spec: x-kubernetes-list-type: atomic type: object azure: - description: Azure contains settings specific to the Azure infrastructure + description: azure contains settings specific to the Azure infrastructure provider. type: object baremetal: - description: BareMetal contains settings specific to the BareMetal + description: baremetal contains settings specific to the BareMetal platform. properties: apiServerInternalIPs: @@ -198,7 +198,7 @@ spec: - message: ingressIPs list is required once set rule: '!has(oldSelf.ingressIPs) || has(self.ingressIPs)' equinixMetal: - description: EquinixMetal contains settings specific to the Equinix + description: equinixMetal contains settings specific to the Equinix Metal infrastructure provider. type: object external: @@ -209,7 +209,7 @@ spec: platformName: default: Unknown description: |- - PlatformName holds the arbitrary string representing the infrastructure provider name, expected to be set at the installation time. + 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 x-kubernetes-validations: @@ -217,19 +217,19 @@ spec: rule: oldSelf == 'Unknown' || self == oldSelf type: object gcp: - description: GCP contains settings specific to the Google Cloud + description: gcp contains settings specific to the Google Cloud Platform infrastructure provider. type: object ibmcloud: - description: IBMCloud contains settings specific to the IBMCloud + description: ibmcloud contains settings specific to the IBMCloud infrastructure provider. type: object kubevirt: - description: Kubevirt contains settings specific to the kubevirt + description: kubevirt contains settings specific to the kubevirt infrastructure provider. type: object nutanix: - description: Nutanix contains settings specific to the Nutanix + description: nutanix contains settings specific to the Nutanix infrastructure provider. properties: failureDomains: @@ -414,7 +414,7 @@ spec: - prismElements type: object openstack: - description: OpenStack contains settings specific to the OpenStack + description: openstack contains settings specific to the OpenStack infrastructure provider. properties: apiServerInternalIPs: @@ -498,11 +498,11 @@ spec: - message: ingressIPs list is required once set rule: '!has(oldSelf.ingressIPs) || has(self.ingressIPs)' ovirt: - description: Ovirt contains settings specific to the oVirt infrastructure + description: ovirt contains settings specific to the oVirt infrastructure provider. type: object powervs: - description: PowerVS contains settings specific to the IBM Power + description: powervs contains settings specific to the IBM Power Systems Virtual Servers infrastructure provider. properties: serviceEndpoints: @@ -584,7 +584,7 @@ spec: - External type: string vsphere: - description: VSphere contains settings specific to the VSphere + description: vsphere contains settings specific to the VSphere infrastructure provider. properties: apiServerInternalIPs: @@ -665,7 +665,7 @@ spec: minLength: 1 type: string topology: - description: Topology describes a given failure domain + description: topology describes a given failure domain using vSphere constructs properties: computeCluster: @@ -1095,7 +1095,7 @@ spec: infrastructure provider. properties: alibabaCloud: - description: AlibabaCloud contains settings specific to the Alibaba + description: alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. properties: region: @@ -1138,7 +1138,7 @@ spec: - region type: object aws: - description: AWS contains settings specific to the Amazon Web + description: aws contains settings specific to the Amazon Web Services infrastructure provider. properties: region: @@ -1179,7 +1179,7 @@ spec: x-kubernetes-list-type: atomic serviceEndpoints: description: |- - ServiceEndpoints list contains custom endpoints which will override default + serviceEndpoints list contains custom endpoints which will override default service endpoint of AWS Services. There must be only one ServiceEndpoint for a service. items: @@ -1206,7 +1206,7 @@ spec: x-kubernetes-list-type: atomic type: object azure: - description: Azure contains settings specific to the Azure infrastructure + description: azure contains settings specific to the Azure infrastructure provider. properties: armEndpoint: @@ -1279,7 +1279,7 @@ spec: rule: '!has(oldSelf.resourceTags) && !has(self.resourceTags) || has(oldSelf.resourceTags) && has(self.resourceTags)' baremetal: - description: BareMetal contains settings specific to the BareMetal + description: baremetal contains settings specific to the BareMetal platform. properties: apiServerInternalIP: @@ -1363,7 +1363,7 @@ spec: type: string type: object equinixMetal: - description: EquinixMetal contains settings specific to the Equinix + description: equinixMetal contains settings specific to the Equinix Metal infrastructure provider. properties: apiServerInternalIP: @@ -1380,7 +1380,7 @@ spec: type: string type: object external: - description: External contains settings specific to the generic + description: external contains settings specific to the generic External infrastructure provider. properties: cloudControllerManager: @@ -1419,7 +1419,7 @@ spec: once set rule: has(self.cloudControllerManager) == has(oldSelf.cloudControllerManager) gcp: - description: GCP contains settings specific to the Google Cloud + description: gcp contains settings specific to the Google Cloud Platform infrastructure provider. properties: projectID: @@ -1432,28 +1432,28 @@ spec: type: string type: object ibmcloud: - description: IBMCloud contains settings specific to the IBMCloud + description: ibmcloud contains settings specific to the IBMCloud infrastructure provider. properties: cisInstanceCRN: description: |- - CISInstanceCRN is the CRN of the Cloud Internet Services instance managing + 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 + 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 + description: location is where the cluster has been deployed type: string providerType: - description: ProviderType indicates the type of cluster that + description: providerType indicates the type of cluster that was created type: string resourceGroupName: - description: ResourceGroupName is the Resource Group for new + description: resourceGroupName is the Resource Group for new IBMCloud resources created for the cluster. type: string serviceEndpoints: @@ -1508,7 +1508,7 @@ spec: x-kubernetes-list-type: map type: object kubevirt: - description: Kubevirt contains settings specific to the kubevirt + description: kubevirt contains settings specific to the kubevirt infrastructure provider. properties: apiServerInternalIP: @@ -1525,7 +1525,7 @@ spec: type: string type: object nutanix: - description: Nutanix contains settings specific to the Nutanix + description: nutanix contains settings specific to the Nutanix infrastructure provider. properties: apiServerInternalIP: @@ -1583,7 +1583,7 @@ spec: : true)' type: object openstack: - description: OpenStack contains settings specific to the OpenStack + description: openstack contains settings specific to the OpenStack infrastructure provider. properties: apiServerInternalIP: @@ -1698,7 +1698,7 @@ spec: type: string type: object ovirt: - description: Ovirt contains settings specific to the oVirt infrastructure + description: ovirt contains settings specific to the oVirt infrastructure provider. properties: apiServerInternalIP: @@ -1760,17 +1760,17 @@ spec: type: string type: object powervs: - description: PowerVS contains settings specific to the Power Systems + description: powervs contains settings specific to the Power Systems Virtual Servers infrastructure provider. properties: cisInstanceCRN: description: |- - CISInstanceCRN is the CRN of the Cloud Internet Services instance managing + 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 + dnsInstanceCRN is the CRN of the DNS Services instance managing the DNS zone for the cluster's base domain type: string region: @@ -1880,7 +1880,7 @@ spec: - External type: string vsphere: - description: VSphere contains settings specific to the VSphere + description: vsphere contains settings specific to the VSphere infrastructure provider. properties: apiServerInternalIP: diff --git a/config/v1/zz_generated.featuregated-crd-manifests/infrastructures.config.openshift.io/VSphereMultiVCenters.yaml b/config/v1/zz_generated.featuregated-crd-manifests/infrastructures.config.openshift.io/VSphereMultiVCenters.yaml index 775cedeadec..5159e957325 100644 --- a/config/v1/zz_generated.featuregated-crd-manifests/infrastructures.config.openshift.io/VSphereMultiVCenters.yaml +++ b/config/v1/zz_generated.featuregated-crd-manifests/infrastructures.config.openshift.io/VSphereMultiVCenters.yaml @@ -62,7 +62,7 @@ spec: All the clients are expected to use the generated ConfigMap only. properties: key: - description: Key allows pointing to a specific key/value inside + description: key allows pointing to a specific key/value inside of the configmap. This is useful for logical file references. type: string name: @@ -74,11 +74,11 @@ spec: infrastructure provider. properties: alibabaCloud: - description: AlibabaCloud contains settings specific to the Alibaba + description: alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. type: object aws: - description: AWS contains settings specific to the Amazon Web + description: aws contains settings specific to the Amazon Web Services infrastructure provider. properties: serviceEndpoints: @@ -110,11 +110,11 @@ spec: x-kubernetes-list-type: atomic type: object azure: - description: Azure contains settings specific to the Azure infrastructure + description: azure contains settings specific to the Azure infrastructure provider. type: object baremetal: - description: BareMetal contains settings specific to the BareMetal + description: baremetal contains settings specific to the BareMetal platform. properties: apiServerInternalIPs: @@ -198,7 +198,7 @@ spec: - message: ingressIPs list is required once set rule: '!has(oldSelf.ingressIPs) || has(self.ingressIPs)' equinixMetal: - description: EquinixMetal contains settings specific to the Equinix + description: equinixMetal contains settings specific to the Equinix Metal infrastructure provider. type: object external: @@ -209,7 +209,7 @@ spec: platformName: default: Unknown description: |- - PlatformName holds the arbitrary string representing the infrastructure provider name, expected to be set at the installation time. + 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 x-kubernetes-validations: @@ -217,19 +217,19 @@ spec: rule: oldSelf == 'Unknown' || self == oldSelf type: object gcp: - description: GCP contains settings specific to the Google Cloud + description: gcp contains settings specific to the Google Cloud Platform infrastructure provider. type: object ibmcloud: - description: IBMCloud contains settings specific to the IBMCloud + description: ibmcloud contains settings specific to the IBMCloud infrastructure provider. type: object kubevirt: - description: Kubevirt contains settings specific to the kubevirt + description: kubevirt contains settings specific to the kubevirt infrastructure provider. type: object nutanix: - description: Nutanix contains settings specific to the Nutanix + description: nutanix contains settings specific to the Nutanix infrastructure provider. properties: failureDomains: @@ -414,7 +414,7 @@ spec: - prismElements type: object openstack: - description: OpenStack contains settings specific to the OpenStack + description: openstack contains settings specific to the OpenStack infrastructure provider. properties: apiServerInternalIPs: @@ -498,11 +498,11 @@ spec: - message: ingressIPs list is required once set rule: '!has(oldSelf.ingressIPs) || has(self.ingressIPs)' ovirt: - description: Ovirt contains settings specific to the oVirt infrastructure + description: ovirt contains settings specific to the oVirt infrastructure provider. type: object powervs: - description: PowerVS contains settings specific to the IBM Power + description: powervs contains settings specific to the IBM Power Systems Virtual Servers infrastructure provider. properties: serviceEndpoints: @@ -584,7 +584,7 @@ spec: - External type: string vsphere: - description: VSphere contains settings specific to the VSphere + description: vsphere contains settings specific to the VSphere infrastructure provider. properties: apiServerInternalIPs: @@ -665,7 +665,7 @@ spec: minLength: 1 type: string topology: - description: Topology describes a given failure domain + description: topology describes a given failure domain using vSphere constructs properties: computeCluster: @@ -1095,7 +1095,7 @@ spec: infrastructure provider. properties: alibabaCloud: - description: AlibabaCloud contains settings specific to the Alibaba + description: alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. properties: region: @@ -1138,7 +1138,7 @@ spec: - region type: object aws: - description: AWS contains settings specific to the Amazon Web + description: aws contains settings specific to the Amazon Web Services infrastructure provider. properties: region: @@ -1179,7 +1179,7 @@ spec: x-kubernetes-list-type: atomic serviceEndpoints: description: |- - ServiceEndpoints list contains custom endpoints which will override default + serviceEndpoints list contains custom endpoints which will override default service endpoint of AWS Services. There must be only one ServiceEndpoint for a service. items: @@ -1206,7 +1206,7 @@ spec: x-kubernetes-list-type: atomic type: object azure: - description: Azure contains settings specific to the Azure infrastructure + description: azure contains settings specific to the Azure infrastructure provider. properties: armEndpoint: @@ -1279,7 +1279,7 @@ spec: rule: '!has(oldSelf.resourceTags) && !has(self.resourceTags) || has(oldSelf.resourceTags) && has(self.resourceTags)' baremetal: - description: BareMetal contains settings specific to the BareMetal + description: baremetal contains settings specific to the BareMetal platform. properties: apiServerInternalIP: @@ -1363,7 +1363,7 @@ spec: type: string type: object equinixMetal: - description: EquinixMetal contains settings specific to the Equinix + description: equinixMetal contains settings specific to the Equinix Metal infrastructure provider. properties: apiServerInternalIP: @@ -1380,7 +1380,7 @@ spec: type: string type: object external: - description: External contains settings specific to the generic + description: external contains settings specific to the generic External infrastructure provider. properties: cloudControllerManager: @@ -1419,7 +1419,7 @@ spec: once set rule: has(self.cloudControllerManager) == has(oldSelf.cloudControllerManager) gcp: - description: GCP contains settings specific to the Google Cloud + description: gcp contains settings specific to the Google Cloud Platform infrastructure provider. properties: projectID: @@ -1432,28 +1432,28 @@ spec: type: string type: object ibmcloud: - description: IBMCloud contains settings specific to the IBMCloud + description: ibmcloud contains settings specific to the IBMCloud infrastructure provider. properties: cisInstanceCRN: description: |- - CISInstanceCRN is the CRN of the Cloud Internet Services instance managing + 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 + 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 + description: location is where the cluster has been deployed type: string providerType: - description: ProviderType indicates the type of cluster that + description: providerType indicates the type of cluster that was created type: string resourceGroupName: - description: ResourceGroupName is the Resource Group for new + description: resourceGroupName is the Resource Group for new IBMCloud resources created for the cluster. type: string serviceEndpoints: @@ -1508,7 +1508,7 @@ spec: x-kubernetes-list-type: map type: object kubevirt: - description: Kubevirt contains settings specific to the kubevirt + description: kubevirt contains settings specific to the kubevirt infrastructure provider. properties: apiServerInternalIP: @@ -1525,7 +1525,7 @@ spec: type: string type: object nutanix: - description: Nutanix contains settings specific to the Nutanix + description: nutanix contains settings specific to the Nutanix infrastructure provider. properties: apiServerInternalIP: @@ -1583,7 +1583,7 @@ spec: : true)' type: object openstack: - description: OpenStack contains settings specific to the OpenStack + description: openstack contains settings specific to the OpenStack infrastructure provider. properties: apiServerInternalIP: @@ -1698,7 +1698,7 @@ spec: type: string type: object ovirt: - description: Ovirt contains settings specific to the oVirt infrastructure + description: ovirt contains settings specific to the oVirt infrastructure provider. properties: apiServerInternalIP: @@ -1760,17 +1760,17 @@ spec: type: string type: object powervs: - description: PowerVS contains settings specific to the Power Systems + description: powervs contains settings specific to the Power Systems Virtual Servers infrastructure provider. properties: cisInstanceCRN: description: |- - CISInstanceCRN is the CRN of the Cloud Internet Services instance managing + 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 + dnsInstanceCRN is the CRN of the DNS Services instance managing the DNS zone for the cluster's base domain type: string region: @@ -1880,7 +1880,7 @@ spec: - External type: string vsphere: - description: VSphere contains settings specific to the VSphere + description: vsphere contains settings specific to the VSphere infrastructure provider. properties: apiServerInternalIP: diff --git a/config/v1/zz_generated.featuregated-crd-manifests/networks.config.openshift.io/AAA_ungated.yaml b/config/v1/zz_generated.featuregated-crd-manifests/networks.config.openshift.io/AAA_ungated.yaml index 611c449726a..88e35698a44 100644 --- a/config/v1/zz_generated.featuregated-crd-manifests/networks.config.openshift.io/AAA_ungated.yaml +++ b/config/v1/zz_generated.featuregated-crd-manifests/networks.config.openshift.io/AAA_ungated.yaml @@ -115,7 +115,7 @@ spec: type: object networkType: description: |- - NetworkType is the plugin that is to be deployed (e.g. OVNKubernetes). + 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: @@ -167,16 +167,16 @@ spec: type: array x-kubernetes-list-type: atomic clusterNetworkMTU: - description: ClusterNetworkMTU is the MTU for inter-pod networking. + description: clusterNetworkMTU is the MTU for inter-pod networking. type: integer migration: - description: Migration contains the cluster network migration configuration. + description: migration contains the cluster network migration configuration. properties: mtu: - description: MTU is the MTU configuration that is being deployed. + description: mtu is the MTU configuration that is being deployed. properties: machine: - description: Machine contains MTU migration configuration + description: machine contains MTU migration configuration for the machine's uplink. properties: from: @@ -191,7 +191,7 @@ spec: type: integer type: object network: - description: Network contains MTU migration configuration + description: network contains MTU migration configuration for the default network. properties: from: @@ -208,13 +208,13 @@ spec: type: object networkType: description: |- - NetworkType is the target plugin that is being deployed. + 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 type: object networkType: - description: NetworkType is the plugin that is deployed (e.g. OVNKubernetes). + description: networkType is the plugin that is deployed (e.g. OVNKubernetes). type: string serviceNetwork: description: |- diff --git a/config/v1/zz_generated.featuregated-crd-manifests/networks.config.openshift.io/NetworkDiagnosticsConfig.yaml b/config/v1/zz_generated.featuregated-crd-manifests/networks.config.openshift.io/NetworkDiagnosticsConfig.yaml index b1ebb620bbb..113df88fd09 100644 --- a/config/v1/zz_generated.featuregated-crd-manifests/networks.config.openshift.io/NetworkDiagnosticsConfig.yaml +++ b/config/v1/zz_generated.featuregated-crd-manifests/networks.config.openshift.io/NetworkDiagnosticsConfig.yaml @@ -261,7 +261,7 @@ spec: type: object networkType: description: |- - NetworkType is the plugin that is to be deployed (e.g. OVNKubernetes). + 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: @@ -319,7 +319,7 @@ spec: type: array x-kubernetes-list-type: atomic clusterNetworkMTU: - description: ClusterNetworkMTU is the MTU for inter-pod networking. + description: clusterNetworkMTU is the MTU for inter-pod networking. type: integer conditions: description: |- @@ -384,13 +384,13 @@ spec: - type x-kubernetes-list-type: map migration: - description: Migration contains the cluster network migration configuration. + description: migration contains the cluster network migration configuration. properties: mtu: - description: MTU is the MTU configuration that is being deployed. + description: mtu is the MTU configuration that is being deployed. properties: machine: - description: Machine contains MTU migration configuration + description: machine contains MTU migration configuration for the machine's uplink. properties: from: @@ -405,7 +405,7 @@ spec: type: integer type: object network: - description: Network contains MTU migration configuration + description: network contains MTU migration configuration for the default network. properties: from: @@ -422,13 +422,13 @@ spec: type: object networkType: description: |- - NetworkType is the target plugin that is being deployed. + 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 type: object networkType: - description: NetworkType is the plugin that is deployed (e.g. OVNKubernetes). + description: networkType is the plugin that is deployed (e.g. OVNKubernetes). type: string serviceNetwork: description: |- diff --git a/config/v1/zz_generated.featuregated-crd-manifests/nodes.config.openshift.io/AAA_ungated.yaml b/config/v1/zz_generated.featuregated-crd-manifests/nodes.config.openshift.io/AAA_ungated.yaml index e7a9a23a9ab..06b50d9ae1f 100644 --- a/config/v1/zz_generated.featuregated-crd-manifests/nodes.config.openshift.io/AAA_ungated.yaml +++ b/config/v1/zz_generated.featuregated-crd-manifests/nodes.config.openshift.io/AAA_ungated.yaml @@ -47,7 +47,7 @@ spec: description: spec holds user settable values for configuration properties: cgroupMode: - description: CgroupMode determines the cgroups version on the node + description: cgroupMode determines the cgroups version on the node enum: - v1 - v2 @@ -55,7 +55,7 @@ spec: type: string workerLatencyProfile: description: |- - WorkerLatencyProfile determins the how fast the kubelet is updating + workerLatencyProfile determins the how fast the kubelet is updating the status and corresponding reaction of the cluster enum: - Default diff --git a/config/v1/zz_generated.featuregated-crd-manifests/nodes.config.openshift.io/MinimumKubeletVersion.yaml b/config/v1/zz_generated.featuregated-crd-manifests/nodes.config.openshift.io/MinimumKubeletVersion.yaml index ffce7121a41..a5d41a28187 100644 --- a/config/v1/zz_generated.featuregated-crd-manifests/nodes.config.openshift.io/MinimumKubeletVersion.yaml +++ b/config/v1/zz_generated.featuregated-crd-manifests/nodes.config.openshift.io/MinimumKubeletVersion.yaml @@ -47,7 +47,7 @@ spec: description: spec holds user settable values for configuration properties: cgroupMode: - description: CgroupMode determines the cgroups version on the node + description: cgroupMode determines the cgroups version on the node enum: - v1 - v2 @@ -76,7 +76,7 @@ spec: rule: self == "" || self.matches('^[0-9]*.[0-9]*.[0-9]*$') workerLatencyProfile: description: |- - WorkerLatencyProfile determins the how fast the kubelet is updating + workerLatencyProfile determins the how fast the kubelet is updating the status and corresponding reaction of the cluster enum: - Default diff --git a/config/v1/zz_generated.featuregated-crd-manifests/proxies.config.openshift.io/AAA_ungated.yaml b/config/v1/zz_generated.featuregated-crd-manifests/proxies.config.openshift.io/AAA_ungated.yaml index b7f18935f6e..d5e8690531d 100644 --- a/config/v1/zz_generated.featuregated-crd-manifests/proxies.config.openshift.io/AAA_ungated.yaml +++ b/config/v1/zz_generated.featuregated-crd-manifests/proxies.config.openshift.io/AAA_ungated.yaml @@ -44,7 +44,7 @@ spec: metadata: type: object spec: - description: Spec holds user-settable values for the proxy configuration + description: spec holds user-settable values for the proxy configuration properties: httpProxy: description: httpProxy is the URL of the proxy for HTTP requests. Empty diff --git a/config/v1/zz_generated.featuregated-crd-manifests/schedulers.config.openshift.io/AAA_ungated.yaml b/config/v1/zz_generated.featuregated-crd-manifests/schedulers.config.openshift.io/AAA_ungated.yaml index 9adb0a9796b..5b04d402127 100644 --- a/config/v1/zz_generated.featuregated-crd-manifests/schedulers.config.openshift.io/AAA_ungated.yaml +++ b/config/v1/zz_generated.featuregated-crd-manifests/schedulers.config.openshift.io/AAA_ungated.yaml @@ -72,7 +72,7 @@ spec: type: string mastersSchedulable: description: |- - MastersSchedulable allows masters nodes to be schedulable. When this flag is + 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. 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 index 241931dcdb5..405806d2e96 100644 --- 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 @@ -72,7 +72,7 @@ spec: type: string mastersSchedulable: description: |- - MastersSchedulable allows masters nodes to be schedulable. When this flag is + 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. diff --git a/config/v1/zz_generated.swagger_doc_generated.go b/config/v1/zz_generated.swagger_doc_generated.go index a89678edb9e..2a2be22e8a9 100644 --- a/config/v1/zz_generated.swagger_doc_generated.go +++ b/config/v1/zz_generated.swagger_doc_generated.go @@ -22,8 +22,8 @@ func (AdmissionConfig) SwaggerDoc() map[string]string { var map_AdmissionPluginConfig = map[string]string{ "": "AdmissionPluginConfig holds the necessary configuration options for admission plugins", - "location": "Location is the path to a configuration file that contains the plugin's configuration", - "configuration": "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.", + "location": "location is the path to a configuration file that contains the plugin's configuration", + "configuration": "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.", } func (AdmissionPluginConfig) SwaggerDoc() map[string]string { @@ -37,8 +37,8 @@ var map_AuditConfig = map[string]string{ "maximumFileRetentionDays": "Maximum number of days to retain old log files based on the timestamp encoded in their filename.", "maximumRetainedFiles": "Maximum number of old log files to retain.", "maximumFileSizeMegabytes": "Maximum size in megabytes of the log file before it gets rotated. Defaults to 100MB.", - "policyFile": "PolicyFile is a path to the file that defines the audit policy configuration.", - "policyConfiguration": "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.", + "policyFile": "policyFile is a path to the file that defines the audit policy configuration.", + "policyConfiguration": "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.", "logFormat": "Format of saved audits (legacy or json).", "webHookKubeConfig": "Path to a .kubeconfig formatted file that defines the audit webhook configuration.", "webHookMode": "Strategy for sending audit events (block or batch).", @@ -50,8 +50,8 @@ func (AuditConfig) SwaggerDoc() map[string]string { var map_CertInfo = map[string]string{ "": "CertInfo relates a certificate with a private key", - "certFile": "CertFile is a file containing a PEM-encoded certificate", - "keyFile": "KeyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile", + "certFile": "certFile is a file containing a PEM-encoded certificate", + "keyFile": "keyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile", } func (CertInfo) SwaggerDoc() map[string]string { @@ -71,7 +71,7 @@ func (ClientConnectionOverrides) SwaggerDoc() map[string]string { var map_ConfigMapFileReference = map[string]string{ "": "ConfigMapFileReference references a config map in a specific namespace. The namespace must be specified at the point of use.", - "key": "Key allows pointing to a specific key/value inside of the configmap. This is useful for logical file references.", + "key": "key allows pointing to a specific key/value inside of the configmap. This is useful for logical file references.", } func (ConfigMapFileReference) SwaggerDoc() map[string]string { @@ -150,8 +150,8 @@ func (GenericControllerConfig) SwaggerDoc() map[string]string { var map_HTTPServingInfo = map[string]string{ "": "HTTPServingInfo holds configuration for serving HTTP", - "maxRequestsInFlight": "MaxRequestsInFlight is the number of concurrent requests allowed to the server. If zero, no limit.", - "requestTimeoutSeconds": "RequestTimeoutSeconds is the number of seconds before requests are timed out. The default is 60 minutes, if -1 there is no limit on requests.", + "maxRequestsInFlight": "maxRequestsInFlight is the number of concurrent requests allowed to the server. If zero, no limit.", + "requestTimeoutSeconds": "requestTimeoutSeconds is the number of seconds before requests are timed out. The default is 60 minutes, if -1 there is no limit on requests.", } func (HTTPServingInfo) SwaggerDoc() map[string]string { @@ -193,7 +193,7 @@ func (MaxAgePolicy) SwaggerDoc() map[string]string { var map_NamedCertificate = map[string]string{ "": "NamedCertificate specifies a certificate/key, and the names it should be served for", - "names": "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.", + "names": "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.", } func (NamedCertificate) SwaggerDoc() map[string]string { @@ -202,8 +202,8 @@ func (NamedCertificate) SwaggerDoc() map[string]string { var map_RemoteConnectionInfo = map[string]string{ "": "RemoteConnectionInfo holds information necessary for establishing a remote connection", - "url": "URL is the remote URL to connect to", - "ca": "CA is the CA for verifying TLS connections", + "url": "url is the remote URL to connect to", + "ca": "ca is the CA for verifying TLS connections", } func (RemoteConnectionInfo) SwaggerDoc() map[string]string { @@ -233,12 +233,12 @@ func (SecretNameReference) SwaggerDoc() map[string]string { var map_ServingInfo = map[string]string{ "": "ServingInfo holds information about serving web pages", - "bindAddress": "BindAddress is the ip:port to serve on", - "bindNetwork": "BindNetwork is the type of network to bind to - defaults to \"tcp4\", accepts \"tcp\", \"tcp4\", and \"tcp6\"", - "clientCA": "ClientCA is the certificate bundle for all the signers that you'll recognize for incoming client certificates", - "namedCertificates": "NamedCertificates is a list of certificates to use to secure requests to specific hostnames", - "minTLSVersion": "MinTLSVersion is the minimum TLS version supported. Values must match version names from https://golang.org/pkg/crypto/tls/#pkg-constants", - "cipherSuites": "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", + "bindAddress": "bindAddress is the ip:port to serve on", + "bindNetwork": "bindNetwork is the type of network to bind to - defaults to \"tcp4\", accepts \"tcp\", \"tcp4\", and \"tcp6\"", + "clientCA": "clientCA is the certificate bundle for all the signers that you'll recognize for incoming client certificates", + "namedCertificates": "namedCertificates is a list of certificates to use to secure requests to specific hostnames", + "minTLSVersion": "minTLSVersion is the minimum TLS version supported. Values must match version names from https://golang.org/pkg/crypto/tls/#pkg-constants", + "cipherSuites": "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", } func (ServingInfo) SwaggerDoc() map[string]string { @@ -255,10 +255,10 @@ func (StringSource) SwaggerDoc() map[string]string { var map_StringSourceSpec = map[string]string{ "": "StringSourceSpec specifies a string value, or external location", - "value": "Value specifies the cleartext value, or an encrypted value if keyFile is specified.", - "env": "Env specifies an envvar containing the cleartext value, or an encrypted value if the keyFile is specified.", - "file": "File references a file containing the cleartext value, or an encrypted value if a keyFile is specified.", - "keyFile": "KeyFile references a file containing the key to use to decrypt the value.", + "value": "value specifies the cleartext value, or an encrypted value if keyFile is specified.", + "env": "env specifies an envvar containing the cleartext value, or an encrypted value if the keyFile is specified.", + "file": "file references a file containing the cleartext value, or an encrypted value if a keyFile is specified.", + "keyFile": "keyFile references a file containing the key to use to decrypt the value.", } func (StringSourceSpec) SwaggerDoc() map[string]string { @@ -369,7 +369,7 @@ var map_AuthenticationSpec = map[string]string{ "webhookTokenAuthenticators": "webhookTokenAuthenticators is DEPRECATED, setting it has no effect.", "webhookTokenAuthenticator": "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\".", "serviceAccountIssuer": "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.", - "oidcProviders": "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.", + "oidcProviders": "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.", } func (AuthenticationSpec) SwaggerDoc() map[string]string { @@ -378,7 +378,7 @@ func (AuthenticationSpec) SwaggerDoc() map[string]string { var map_AuthenticationStatus = map[string]string{ "integratedOAuthMetadata": "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.", - "oidcClients": "OIDCClients is where participating operators place the current OIDC client status for OIDC clients that can be customized by the cluster-admin.", + "oidcClients": "oidcClients is where participating operators place the current OIDC client status for OIDC clients that can be customized by the cluster-admin.", } func (AuthenticationStatus) SwaggerDoc() map[string]string { @@ -395,11 +395,11 @@ func (DeprecatedWebhookTokenAuthenticator) SwaggerDoc() map[string]string { } var map_OIDCClientConfig = map[string]string{ - "componentName": "ComponentName is the name of the component that is supposed to consume this client configuration", - "componentNamespace": "ComponentNamespace is the namespace of the component that is supposed to consume this client configuration", - "clientID": "ClientID is the identifier of the OIDC client from the OIDC provider", - "clientSecret": "ClientSecret refers to a secret in the `openshift-config` namespace that contains the client secret in the `clientSecret` key of the `.data` field", - "extraScopes": "ExtraScopes is an optional set of scopes to request tokens with.", + "componentName": "componentName is the name of the component that is supposed to consume this client configuration", + "componentNamespace": "componentNamespace is the namespace of the component that is supposed to consume this client configuration", + "clientID": "clientID is the identifier of the OIDC client from the OIDC provider", + "clientSecret": "clientSecret refers to a secret in the `openshift-config` namespace that contains the client secret in the `clientSecret` key of the `.data` field", + "extraScopes": "extraScopes is an optional set of scopes to request tokens with.", } func (OIDCClientConfig) SwaggerDoc() map[string]string { @@ -409,7 +409,7 @@ func (OIDCClientConfig) SwaggerDoc() map[string]string { var map_OIDCClientReference = map[string]string{ "oidcProviderName": "OIDCName refers to the `name` of the provider from `oidcProviders`", "issuerURL": "URL is the serving URL of the token issuer. Must use the https:// scheme.", - "clientID": "ClientID is the identifier of the OIDC client from the OIDC provider", + "clientID": "clientID is the identifier of the OIDC client from the OIDC provider", } func (OIDCClientReference) SwaggerDoc() map[string]string { @@ -417,11 +417,11 @@ func (OIDCClientReference) SwaggerDoc() map[string]string { } var map_OIDCClientStatus = map[string]string{ - "componentName": "ComponentName is the name of the component that will consume a client configuration.", - "componentNamespace": "ComponentNamespace is the namespace of the component that will consume a client configuration.", - "currentOIDCClients": "CurrentOIDCClients is a list of clients that the component is currently using.", - "consumingUsers": "ConsumingUsers is a slice of ServiceAccounts that need to have read permission on the `clientSecret` secret.", - "conditions": "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.", + "componentName": "componentName is the name of the component that will consume a client configuration.", + "componentNamespace": "componentNamespace is the namespace of the component that will consume a client configuration.", + "currentOIDCClients": "currentOIDCClients is a list of clients that the component is currently using.", + "consumingUsers": "consumingUsers is a slice of ServiceAccounts that need to have read permission on the `clientSecret` secret.", + "conditions": "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.", } func (OIDCClientStatus) SwaggerDoc() map[string]string { @@ -429,11 +429,11 @@ func (OIDCClientStatus) SwaggerDoc() map[string]string { } var map_OIDCProvider = map[string]string{ - "name": "Name of the OIDC provider", - "issuer": "Issuer describes atributes of the OIDC token issuer", - "oidcClients": "OIDCClients contains configuration for the platform's clients that need to request tokens from the issuer", - "claimMappings": "ClaimMappings describes rules on how to transform information from an ID token into a cluster identity", - "claimValidationRules": "ClaimValidationRules are rules that are applied to validate token claims to authenticate users.", + "name": "name of the OIDC provider", + "issuer": "issuer describes atributes of the OIDC token issuer", + "oidcClients": "oidcClients contains configuration for the platform's clients that need to request tokens from the issuer", + "claimMappings": "claimMappings describes rules on how to transform information from an ID token into a cluster identity", + "claimValidationRules": "claimValidationRules are rules that are applied to validate token claims to authenticate users.", } func (OIDCProvider) SwaggerDoc() map[string]string { @@ -441,7 +441,7 @@ func (OIDCProvider) SwaggerDoc() map[string]string { } var map_PrefixedClaimMapping = map[string]string{ - "prefix": "Prefix is a string to prefix the value from the token in the result of the claim mapping.\n\nBy default, no prefixing occurs.\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\".", + "prefix": "prefix is a string to prefix the value from the token in the result of the claim mapping.\n\nBy default, no prefixing occurs.\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\".", } func (PrefixedClaimMapping) SwaggerDoc() map[string]string { @@ -449,7 +449,7 @@ func (PrefixedClaimMapping) SwaggerDoc() map[string]string { } var map_TokenClaimMapping = map[string]string{ - "claim": "Claim is a JWT token claim to be used in the mapping", + "claim": "claim is a JWT token claim to be used in the mapping", } func (TokenClaimMapping) SwaggerDoc() map[string]string { @@ -457,8 +457,8 @@ func (TokenClaimMapping) SwaggerDoc() map[string]string { } var map_TokenClaimMappings = map[string]string{ - "username": "Username is a name of the claim that should be used to construct usernames for the cluster identity.\n\nDefault value: \"sub\"", - "groups": "Groups is a name of the claim that should be used to construct groups for the cluster identity. The referenced claim must use array of strings values.", + "username": "username is a name of the claim that should be used to construct usernames for the cluster identity.\n\nDefault value: \"sub\"", + "groups": "groups is a name of the claim that should be used to construct groups for the cluster identity. The referenced claim must use array of strings values.", } func (TokenClaimMappings) SwaggerDoc() map[string]string { @@ -466,8 +466,8 @@ func (TokenClaimMappings) SwaggerDoc() map[string]string { } var map_TokenClaimValidationRule = map[string]string{ - "type": "Type sets the type of the validation rule", - "requiredClaim": "RequiredClaim allows configuring a required claim name and its expected value", + "type": "type sets the type of the validation rule", + "requiredClaim": "requiredClaim allows configuring a required claim name and its expected value", } func (TokenClaimValidationRule) SwaggerDoc() map[string]string { @@ -476,7 +476,7 @@ func (TokenClaimValidationRule) SwaggerDoc() map[string]string { var map_TokenIssuer = map[string]string{ "issuerURL": "URL is the serving URL of the token issuer. Must use the https:// scheme.", - "audiences": "Audiences is an array of audiences that the token was issued for. Valid tokens must include at least one of these values in their \"aud\" claim. Must be set to exactly one value.", + "audiences": "audiences is an array of audiences that the token was issued for. Valid tokens must include at least one of these values in their \"aud\" claim. Must be set to exactly one value.", "issuerCertificateAuthority": "CertificateAuthority is a reference to a config map in the configuration namespace. The .data of the configMap must contain the \"ca-bundle.crt\" key. If unset, system trust is used instead.", } @@ -485,8 +485,8 @@ func (TokenIssuer) SwaggerDoc() map[string]string { } var map_TokenRequiredClaim = map[string]string{ - "claim": "Claim is a name of a required claim. Only claims with string values are supported.", - "requiredValue": "RequiredValue is the required value for the claim.", + "claim": "claim is a name of a required claim. Only claims with string values are supported.", + "requiredValue": "requiredValue is the required value for the claim.", } func (TokenRequiredClaim) SwaggerDoc() map[string]string { @@ -494,7 +494,7 @@ func (TokenRequiredClaim) SwaggerDoc() map[string]string { } var map_UsernameClaimMapping = map[string]string{ - "prefixPolicy": "PrefixPolicy specifies how a prefix should apply.\n\nBy default, claims other than `email` will be prefixed with the issuer URL to prevent naming clashes with other plugins.\n\nSet to \"NoPrefix\" to disable prefixing.\n\nExample:\n (1) `prefix` is set to \"myoidc:\" and `claim` is set to \"username\".\n If the JWT claim `username` contains value `userA`, the resulting\n mapped value will be \"myoidc:userA\".\n (2) `prefix` is set to \"myoidc:\" and `claim` is set to \"email\". If the\n JWT `email` claim contains value \"userA@myoidc.tld\", the resulting\n mapped value will be \"myoidc:userA@myoidc.tld\".\n (3) `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 (a) \"username\": the mapped value will be \"https://myoidc.tld#userA\"\n (b) \"email\": the mapped value will be \"userA@myoidc.tld\"", + "prefixPolicy": "prefixPolicy specifies how a prefix should apply.\n\nBy default, claims other than `email` will be prefixed with the issuer URL to prevent naming clashes with other plugins.\n\nSet to \"NoPrefix\" to disable prefixing.\n\nExample:\n (1) `prefix` is set to \"myoidc:\" and `claim` is set to \"username\".\n If the JWT claim `username` contains value `userA`, the resulting\n mapped value will be \"myoidc:userA\".\n (2) `prefix` is set to \"myoidc:\" and `claim` is set to \"email\". If the\n JWT `email` claim contains value \"userA@myoidc.tld\", the resulting\n mapped value will be \"myoidc:userA@myoidc.tld\".\n (3) `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 (a) \"username\": the mapped value will be \"https://myoidc.tld#userA\"\n (b) \"email\": the mapped value will be \"userA@myoidc.tld\"", } func (UsernameClaimMapping) SwaggerDoc() map[string]string { @@ -513,7 +513,7 @@ func (WebhookTokenAuthenticator) SwaggerDoc() map[string]string { var map_Build = map[string]string{ "": "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).", "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "spec": "Spec holds user-settable values for the build controller configuration", + "spec": "spec holds user-settable values for the build controller configuration", } func (Build) SwaggerDoc() map[string]string { @@ -521,11 +521,11 @@ func (Build) SwaggerDoc() map[string]string { } var map_BuildDefaults = map[string]string{ - "defaultProxy": "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.", - "gitProxy": "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.", - "env": "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", - "imageLabels": "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.", - "resources": "Resources defines resource requirements to execute the build.", + "defaultProxy": "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.", + "gitProxy": "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.", + "env": "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", + "imageLabels": "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.", + "resources": "resources defines resource requirements to execute the build.", } func (BuildDefaults) SwaggerDoc() map[string]string { @@ -542,8 +542,8 @@ func (BuildList) SwaggerDoc() map[string]string { } var map_BuildOverrides = map[string]string{ - "imageLabels": "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.", - "nodeSelector": "NodeSelector is a selector which must be true for the build pod to fit on a node", + "imageLabels": "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.", + "nodeSelector": "nodeSelector is a selector which must be true for the build pod to fit on a node", "tolerations": "Tolerations is a list of Tolerations that will override any existing tolerations set on a build pod.", "forcePull": "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", } @@ -553,9 +553,9 @@ func (BuildOverrides) SwaggerDoc() map[string]string { } var map_BuildSpec = map[string]string{ - "additionalTrustedCA": "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.", - "buildDefaults": "BuildDefaults controls the default information for Builds", - "buildOverrides": "BuildOverrides controls override settings for builds", + "additionalTrustedCA": "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.", + "buildDefaults": "buildDefaults controls the default information for Builds", + "buildOverrides": "buildOverrides controls override settings for builds", } func (BuildSpec) SwaggerDoc() map[string]string { @@ -563,8 +563,8 @@ func (BuildSpec) SwaggerDoc() map[string]string { } var map_ImageLabel = map[string]string{ - "name": "Name defines the name of the label. It must have non-zero length.", - "value": "Value defines the literal value of the label.", + "name": "name defines the name of the label. It must have non-zero length.", + "value": "value defines the literal value of the label.", } func (ImageLabel) SwaggerDoc() map[string]string { @@ -648,7 +648,7 @@ func (OperandVersion) SwaggerDoc() map[string]string { var map_ClusterCondition = map[string]string{ "": "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": "type represents the cluster-condition type. This defines the members and semantics of any additional properties.", - "promql": "promQL represents a cluster condition based on PromQL.", + "promql": "promql represents a cluster condition based on PromQL.", } func (ClusterCondition) SwaggerDoc() map[string]string { @@ -764,7 +764,7 @@ func (ConditionalUpdateRisk) SwaggerDoc() map[string]string { var map_PromQLClusterCondition = map[string]string{ "": "PromQLClusterCondition represents a cluster condition based on PromQL.", - "promql": "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.", + "promql": "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.", } func (PromQLClusterCondition) SwaggerDoc() map[string]string { @@ -1187,7 +1187,7 @@ func (AWSPlatformSpec) SwaggerDoc() map[string]string { var map_AWSPlatformStatus = map[string]string{ "": "AWSPlatformStatus holds the current status of the Amazon Web Services infrastructure provider.", "region": "region holds the default AWS region for new AWS resources created by the cluster.", - "serviceEndpoints": "ServiceEndpoints list contains custom endpoints which will override default service endpoint of AWS Services. There must be only one ServiceEndpoint for a service.", + "serviceEndpoints": "serviceEndpoints list contains custom endpoints which will override default service endpoint of AWS Services. There must be only one ServiceEndpoint for a service.", "resourceTags": "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.", "cloudLoadBalancerConfig": "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.", } @@ -1361,7 +1361,7 @@ func (EquinixMetalPlatformStatus) SwaggerDoc() map[string]string { var map_ExternalPlatformSpec = map[string]string{ "": "ExternalPlatformSpec holds the desired state for the generic External infrastructure provider.", - "platformName": "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.", + "platformName": "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.", } func (ExternalPlatformSpec) SwaggerDoc() map[string]string { @@ -1429,11 +1429,11 @@ func (IBMCloudPlatformSpec) SwaggerDoc() map[string]string { var map_IBMCloudPlatformStatus = map[string]string{ "": "IBMCloudPlatformStatus holds the current status of the IBMCloud infrastructure provider.", - "location": "Location is where the cluster has been deployed", - "resourceGroupName": "ResourceGroupName is the Resource Group for new IBMCloud resources created for the cluster.", - "providerType": "ProviderType indicates the type of cluster that was created", - "cisInstanceCRN": "CISInstanceCRN is the CRN of the Cloud Internet Services instance managing the DNS zone for the cluster's base domain", - "dnsInstanceCRN": "DNSInstanceCRN is the CRN of the DNS Services instance managing the DNS zone for the cluster's base domain", + "location": "location is where the cluster has been deployed", + "resourceGroupName": "resourceGroupName is the Resource Group for new IBMCloud resources created for the cluster.", + "providerType": "providerType indicates the type of cluster that was created", + "cisInstanceCRN": "cisInstanceCRN is the CRN of the Cloud Internet Services instance managing the DNS zone for the cluster's base domain", + "dnsInstanceCRN": "dnsInstanceCRN is the CRN of the DNS Services instance managing the DNS zone for the cluster's base domain", "serviceEndpoints": "serviceEndpoints is a list of custom endpoints which will override the default service endpoints of an IBM Cloud service. These endpoints are consumed by components within the cluster to reach the respective IBM Cloud Services.", } @@ -1661,19 +1661,19 @@ func (OvirtPlatformStatus) SwaggerDoc() map[string]string { var map_PlatformSpec = map[string]string{ "": "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": "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.", - "aws": "AWS contains settings specific to the Amazon Web Services infrastructure provider.", - "azure": "Azure contains settings specific to the Azure infrastructure provider.", - "gcp": "GCP contains settings specific to the Google Cloud Platform infrastructure provider.", - "baremetal": "BareMetal contains settings specific to the BareMetal platform.", - "openstack": "OpenStack contains settings specific to the OpenStack infrastructure provider.", - "ovirt": "Ovirt contains settings specific to the oVirt infrastructure provider.", - "vsphere": "VSphere contains settings specific to the VSphere infrastructure provider.", - "ibmcloud": "IBMCloud contains settings specific to the IBMCloud infrastructure provider.", - "kubevirt": "Kubevirt contains settings specific to the kubevirt infrastructure provider.", - "equinixMetal": "EquinixMetal contains settings specific to the Equinix Metal infrastructure provider.", - "powervs": "PowerVS contains settings specific to the IBM Power Systems Virtual Servers infrastructure provider.", - "alibabaCloud": "AlibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider.", - "nutanix": "Nutanix contains settings specific to the Nutanix infrastructure provider.", + "aws": "aws contains settings specific to the Amazon Web Services infrastructure provider.", + "azure": "azure contains settings specific to the Azure infrastructure provider.", + "gcp": "gcp contains settings specific to the Google Cloud Platform infrastructure provider.", + "baremetal": "baremetal contains settings specific to the BareMetal platform.", + "openstack": "openstack contains settings specific to the OpenStack infrastructure provider.", + "ovirt": "ovirt contains settings specific to the oVirt infrastructure provider.", + "vsphere": "vsphere contains settings specific to the VSphere infrastructure provider.", + "ibmcloud": "ibmcloud contains settings specific to the IBMCloud infrastructure provider.", + "kubevirt": "kubevirt contains settings specific to the kubevirt infrastructure provider.", + "equinixMetal": "equinixMetal contains settings specific to the Equinix Metal infrastructure provider.", + "powervs": "powervs contains settings specific to the IBM Power Systems Virtual Servers infrastructure provider.", + "alibabaCloud": "alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider.", + "nutanix": "nutanix contains settings specific to the Nutanix infrastructure provider.", "external": "ExternalPlatformType represents generic infrastructure provider. Platform-specific components should be supplemented separately.", } @@ -1684,20 +1684,20 @@ func (PlatformSpec) SwaggerDoc() map[string]string { var map_PlatformStatus = map[string]string{ "": "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": "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.", - "aws": "AWS contains settings specific to the Amazon Web Services infrastructure provider.", - "azure": "Azure contains settings specific to the Azure infrastructure provider.", - "gcp": "GCP contains settings specific to the Google Cloud Platform infrastructure provider.", - "baremetal": "BareMetal contains settings specific to the BareMetal platform.", - "openstack": "OpenStack contains settings specific to the OpenStack infrastructure provider.", - "ovirt": "Ovirt contains settings specific to the oVirt infrastructure provider.", - "vsphere": "VSphere contains settings specific to the VSphere infrastructure provider.", - "ibmcloud": "IBMCloud contains settings specific to the IBMCloud infrastructure provider.", - "kubevirt": "Kubevirt contains settings specific to the kubevirt infrastructure provider.", - "equinixMetal": "EquinixMetal contains settings specific to the Equinix Metal infrastructure provider.", - "powervs": "PowerVS contains settings specific to the Power Systems Virtual Servers infrastructure provider.", - "alibabaCloud": "AlibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider.", - "nutanix": "Nutanix contains settings specific to the Nutanix infrastructure provider.", - "external": "External contains settings specific to the generic External infrastructure provider.", + "aws": "aws contains settings specific to the Amazon Web Services infrastructure provider.", + "azure": "azure contains settings specific to the Azure infrastructure provider.", + "gcp": "gcp contains settings specific to the Google Cloud Platform infrastructure provider.", + "baremetal": "baremetal contains settings specific to the BareMetal platform.", + "openstack": "openstack contains settings specific to the OpenStack infrastructure provider.", + "ovirt": "ovirt contains settings specific to the oVirt infrastructure provider.", + "vsphere": "vsphere contains settings specific to the VSphere infrastructure provider.", + "ibmcloud": "ibmcloud contains settings specific to the IBMCloud infrastructure provider.", + "kubevirt": "kubevirt contains settings specific to the kubevirt infrastructure provider.", + "equinixMetal": "equinixMetal contains settings specific to the Equinix Metal infrastructure provider.", + "powervs": "powervs contains settings specific to the Power Systems Virtual Servers infrastructure provider.", + "alibabaCloud": "alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider.", + "nutanix": "nutanix contains settings specific to the Nutanix infrastructure provider.", + "external": "external contains settings specific to the generic External infrastructure provider.", } func (PlatformStatus) SwaggerDoc() map[string]string { @@ -1719,8 +1719,8 @@ var map_PowerVSPlatformStatus = map[string]string{ "zone": "zone holds the default zone for the new Power VS resources created by the cluster. Note: Currently only single-zone OCP clusters are supported", "resourceGroup": "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.", "serviceEndpoints": "serviceEndpoints is a list of custom endpoints which will override the default service endpoints of a Power VS service.", - "cisInstanceCRN": "CISInstanceCRN is the CRN of the Cloud Internet Services instance managing the DNS zone for the cluster's base domain", - "dnsInstanceCRN": "DNSInstanceCRN is the CRN of the DNS Services instance managing the DNS zone for the cluster's base domain", + "cisInstanceCRN": "cisInstanceCRN is the CRN of the Cloud Internet Services instance managing the DNS zone for the cluster's base domain", + "dnsInstanceCRN": "dnsInstanceCRN is the CRN of the DNS Services instance managing the DNS zone for the cluster's base domain", } func (PowerVSPlatformStatus) SwaggerDoc() map[string]string { @@ -1775,7 +1775,7 @@ var map_VSpherePlatformFailureDomainSpec = map[string]string{ "regionAffinity": "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.", "zoneAffinity": "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.", "server": "server is the fully-qualified domain name or the IP address of the vCenter server.", - "topology": "Topology describes a given failure domain using vSphere constructs", + "topology": "topology describes a given failure domain using vSphere constructs", } func (VSpherePlatformFailureDomainSpec) SwaggerDoc() map[string]string { @@ -1994,8 +1994,8 @@ func (ExternalIPPolicy) SwaggerDoc() map[string]string { var map_MTUMigration = map[string]string{ "": "MTUMigration contains infomation about MTU migration.", - "network": "Network contains MTU migration configuration for the default network.", - "machine": "Machine contains MTU migration configuration for the machine's uplink.", + "network": "network contains MTU migration configuration for the default network.", + "machine": "machine contains MTU migration configuration for the machine's uplink.", } func (MTUMigration) SwaggerDoc() map[string]string { @@ -2064,8 +2064,8 @@ func (NetworkList) SwaggerDoc() map[string]string { var map_NetworkMigration = map[string]string{ "": "NetworkMigration represents the network migration status.", - "networkType": "NetworkType is the target plugin that is being deployed. DEPRECATED: network type migration is no longer supported, so this should always be unset.", - "mtu": "MTU is the MTU configuration that is being deployed.", + "networkType": "networkType is the target plugin that is being deployed. DEPRECATED: network type migration is no longer supported, so this should always be unset.", + "mtu": "mtu is the MTU configuration that is being deployed.", } func (NetworkMigration) SwaggerDoc() map[string]string { @@ -2076,7 +2076,7 @@ var map_NetworkSpec = map[string]string{ "": "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.", "clusterNetwork": "IP address pool to use for pod IPs. This field is immutable after installation.", "serviceNetwork": "IP address pool for services. Currently, we only support a single entry here. This field is immutable after installation.", - "networkType": "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.", + "networkType": "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.", "externalIP": "externalIP defines configuration for controllers that affect Service.ExternalIP. If nil, then ExternalIP is not allowed to be set.", "serviceNodePortRange": "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.", "networkDiagnostics": "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.", @@ -2090,9 +2090,9 @@ var map_NetworkStatus = map[string]string{ "": "NetworkStatus is the current network configuration.", "clusterNetwork": "IP address pool to use for pod IPs.", "serviceNetwork": "IP address pool for services. Currently, we only support a single entry here.", - "networkType": "NetworkType is the plugin that is deployed (e.g. OVNKubernetes).", - "clusterNetworkMTU": "ClusterNetworkMTU is the MTU for inter-pod networking.", - "migration": "Migration contains the cluster network migration configuration.", + "networkType": "networkType is the plugin that is deployed (e.g. OVNKubernetes).", + "clusterNetworkMTU": "clusterNetworkMTU is the MTU for inter-pod networking.", + "migration": "migration contains the cluster network migration configuration.", "conditions": "conditions represents the observations of a network.config current state. Known .status.conditions.type are: \"NetworkDiagnosticsAvailable\"", } @@ -2121,8 +2121,8 @@ func (NodeList) SwaggerDoc() map[string]string { } var map_NodeSpec = map[string]string{ - "cgroupMode": "CgroupMode determines the cgroups version on the node", - "workerLatencyProfile": "WorkerLatencyProfile determins the how fast the kubelet is updating the status and corresponding reaction of the cluster", + "cgroupMode": "cgroupMode determines the cgroups version on the node", + "workerLatencyProfile": "workerLatencyProfile determins the how fast the kubelet is updating the status and corresponding reaction of the cluster", "minimumKubeletVersion": "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.", } @@ -2470,7 +2470,7 @@ func (TemplateReference) SwaggerDoc() map[string]string { var map_Proxy = map[string]string{ "": "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).", "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "spec": "Spec holds user-settable values for the proxy configuration", + "spec": "spec holds user-settable values for the proxy configuration", "status": "status holds observed values from the cluster. They may not be overridden.", } @@ -2545,7 +2545,7 @@ var map_SchedulerSpec = map[string]string{ "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.", + "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 { @@ -2553,8 +2553,8 @@ func (SchedulerSpec) SwaggerDoc() map[string]string { } var map_FeatureGateTests = map[string]string{ - "featureGate": "FeatureGate is the name of the FeatureGate as it appears in The FeatureGate CR instance.", - "tests": "Tests contains an item for every TestName", + "featureGate": "featureGate is the name of the FeatureGate as it appears in The FeatureGate CR instance.", + "tests": "tests contains an item for every TestName", } func (FeatureGateTests) SwaggerDoc() map[string]string { @@ -2562,7 +2562,7 @@ func (FeatureGateTests) SwaggerDoc() map[string]string { } var map_TestDetails = map[string]string{ - "testName": "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.", + "testName": "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.", } func (TestDetails) SwaggerDoc() map[string]string { @@ -2580,7 +2580,7 @@ func (TestReporting) SwaggerDoc() map[string]string { } var map_TestReportingSpec = map[string]string{ - "testsForFeatureGates": "TestsForFeatureGates is a list, indexed by FeatureGate and includes information about testing.", + "testsForFeatureGates": "testsForFeatureGates is a list, indexed by FeatureGate and includes information about testing.", } func (TestReportingSpec) SwaggerDoc() map[string]string { diff --git a/config/v1alpha1/types_backup.go b/config/v1alpha1/types_backup.go index 65eb5c1f759..e52a2e5c536 100644 --- a/config/v1alpha1/types_backup.go +++ b/config/v1alpha1/types_backup.go @@ -24,18 +24,16 @@ type Backup struct { metav1.ObjectMeta `json:"metadata,omitempty"` // spec holds user settable values for configuration - // +kubebuilder:validation:Required // +required Spec BackupSpec `json:"spec"` // status holds observed values from the cluster. They may not be overridden. - // +kubebuilder:validation:Optional // +optional Status BackupStatus `json:"status"` } type BackupSpec struct { // etcd specifies the configuration for periodic backups of the etcd cluster - // +kubebuilder:validation:Required + // +required EtcdBackupSpec EtcdBackupSpec `json:"etcd"` } @@ -45,12 +43,11 @@ type BackupStatus struct { // EtcdBackupSpec provides configuration for automated etcd backups to the cluster-etcd-operator type EtcdBackupSpec struct { - // Schedule defines the recurring backup schedule in Cron format + // 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. - // +kubebuilder:validation:Optional // +optional // +kubebuilder:validation:Pattern:=`^(@(annually|yearly|monthly|weekly|daily|hourly))|(\*|(?:\*|(?:[0-9]|(?:[1-5][0-9])))\/(?:[0-9]|(?:[1-5][0-9]))|(?:[0-9]|(?:[1-5][0-9]))(?:(?:\-[0-9]|\-(?:[1-5][0-9]))?|(?:\,(?:[0-9]|(?:[1-5][0-9])))*)) (\*|(?:\*|(?:\*|(?:[0-9]|1[0-9]|2[0-3])))\/(?:[0-9]|1[0-9]|2[0-3])|(?:[0-9]|1[0-9]|2[0-3])(?:(?:\-(?:[0-9]|1[0-9]|2[0-3]))?|(?:\,(?:[0-9]|1[0-9]|2[0-3]))*)) (\*|(?:[1-9]|(?:[12][0-9])|3[01])(?:(?:\-(?:[1-9]|(?:[12][0-9])|3[01]))?|(?:\,(?:[1-9]|(?:[12][0-9])|3[01]))*)) (\*|(?:[1-9]|1[012]|JAN|FEB|MAR|APR|MAY|JUN|JUL|AUG|SEP|OCT|NOV|DEC)(?:(?:\-(?:[1-9]|1[012]|JAN|FEB|MAR|APR|MAY|JUN|JUL|AUG|SEP|OCT|NOV|DEC))?|(?:\,(?:[1-9]|1[012]|JAN|FEB|MAR|APR|MAY|JUN|JUL|AUG|SEP|OCT|NOV|DEC))*)) (\*|(?:[0-6]|SUN|MON|TUE|WED|THU|FRI|SAT)(?:(?:\-(?:[0-6]|SUN|MON|TUE|WED|THU|FRI|SAT))?|(?:\,(?:[0-6]|SUN|MON|TUE|WED|THU|FRI|SAT))*))$` Schedule string `json:"schedule"` @@ -73,7 +70,6 @@ type EtcdBackupSpec struct { // 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 - // +kubebuilder:validation:Optional // +optional // +kubebuilder:validation:Pattern:=`^([A-Za-z_]+([+-]*0)*|[A-Za-z_]+(\/[A-Za-z_]+){1,2})(\/GMT[+-]\d{1,2})?$` TimeZone string `json:"timeZone"` @@ -84,17 +80,15 @@ type EtcdBackupSpec struct { // [A-Za-z_]+(/[A-Za-z_]+){1,2} - One or more alphabetical characters (uppercase or lowercase) or underscores, followed by one or two occurrences of a forward slash followed by one or more alphabetical characters or underscores. This allows for matching timezone identifiers with 2 or 3 parts, e.g America/Argentina/Buenos_Aires // (/GMT[+-]\d{1,2})? - Makes the GMT offset suffix optional. It matches "/GMT" followed by either a plus ("+") or minus ("-") sign and one or two digits (the GMT offset) - // RetentionPolicy defines the retention policy for retaining and deleting existing backups. - // +kubebuilder:validation:Optional + // retentionPolicy defines the retention policy for retaining and deleting existing backups. // +optional RetentionPolicy RetentionPolicy `json:"retentionPolicy"` - // PVCName specifies the name of the PersistentVolumeClaim (PVC) which binds a PersistentVolume where the + // 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. - // +kubebuilder:validation:Optional // +optional PVCName string `json:"pvcName"` } @@ -115,45 +109,40 @@ const ( // This struct is a discriminated union that allows users to select the type of retention policy from the supported types. // +union type RetentionPolicy struct { - // RetentionType sets the type of retention policy. + // 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. // +unionDiscriminator // +required - // +kubebuilder:validation:Required // +kubebuilder:validation:Enum:="";"RetentionNumber";"RetentionSize" RetentionType RetentionType `json:"retentionType"` - // RetentionNumber configures the retention policy based on the number of backups - // +kubebuilder:validation:Optional + // retentionNumber configures the retention policy based on the number of backups // +optional RetentionNumber *RetentionNumberConfig `json:"retentionNumber,omitempty"` - // RetentionSize configures the retention policy based on the size of backups - // +kubebuilder:validation:Optional + // retentionSize configures the retention policy based on the size of backups // +optional RetentionSize *RetentionSizeConfig `json:"retentionSize,omitempty"` } // RetentionNumberConfig specifies the configuration of the retention policy on the number of backups type RetentionNumberConfig struct { - // MaxNumberOfBackups defines the maximum number of backups to retain. + // 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. // +kubebuilder:validation:Minimum=1 - // +kubebuilder:validation:Required // +required MaxNumberOfBackups int `json:"maxNumberOfBackups,omitempty"` } // RetentionSizeConfig specifies the configuration of the retention policy on the total size of backups type RetentionSizeConfig struct { - // MaxSizeOfBackupsGb defines the total size in GB of backups to retain. + // 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. // +kubebuilder:validation:Minimum=1 - // +kubebuilder:validation:Required // +required MaxSizeOfBackupsGb int `json:"maxSizeOfBackupsGb,omitempty"` } diff --git a/config/v1alpha1/types_cluster_image_policy.go b/config/v1alpha1/types_cluster_image_policy.go index 14650fd48f4..5eaeeea736b 100644 --- a/config/v1alpha1/types_cluster_image_policy.go +++ b/config/v1alpha1/types_cluster_image_policy.go @@ -24,7 +24,7 @@ type ClusterImagePolicy struct { metav1.ObjectMeta `json:"metadata,omitempty"` // spec contains the configuration for the cluster image policy. - // +kubebuilder:validation:Required + // +required Spec ClusterImagePolicySpec `json:"spec"` // status contains the observed state of the resource. // +optional @@ -44,13 +44,13 @@ type ClusterImagePolicySpec struct { // 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 - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:MaxItems=256 // +listType=set Scopes []ImageScope `json:"scopes"` // policy contains configuration to allow scopes to be verified, and defines how // images not matching the verification policy will be treated. - // +kubebuilder:validation:Required + // +required Policy Policy `json:"policy"` } diff --git a/config/v1alpha1/types_image_policy.go b/config/v1alpha1/types_image_policy.go index a177ddb0d66..7f57d88f915 100644 --- a/config/v1alpha1/types_image_policy.go +++ b/config/v1alpha1/types_image_policy.go @@ -23,7 +23,7 @@ type ImagePolicy struct { metav1.ObjectMeta `json:"metadata,omitempty"` // spec holds user settable values for configuration - // +kubebuilder:validation:Required + // +required Spec ImagePolicySpec `json:"spec"` // status contains the observed state of the resource. // +optional @@ -43,13 +43,13 @@ type ImagePolicySpec struct { // 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 - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:MaxItems=256 // +listType=set Scopes []ImageScope `json:"scopes"` // policy contains configuration to allow scopes to be verified, and defines how // images not matching the verification policy will be treated. - // +kubebuilder:validation:Required + // +required Policy Policy `json:"policy"` } @@ -62,7 +62,7 @@ type ImageScope string // Policy defines the verification policy for the items in the scopes list. type Policy struct { // rootOfTrust specifies the root of trust for the policy. - // +kubebuilder:validation:Required + // +required RootOfTrust PolicyRootOfTrust `json:"rootOfTrust"` // 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". // +optional @@ -78,7 +78,7 @@ type PolicyRootOfTrust struct { // "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. // +unionDiscriminator - // +kubebuilder:validation:Required + // +required PolicyType PolicyType `json:"policyType"` // publicKey defines the root of trust based on a sigstore public key. // +optional @@ -102,7 +102,7 @@ const ( type PublicKey struct { // keyData contains inline base64-encoded data for the PEM format public key. // KeyData must be at most 8192 characters. - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:MaxLength=8192 KeyData []byte `json:"keyData"` // rekorKeyData contains inline base64-encoded data for the PEM format from the Rekor public key. @@ -116,16 +116,16 @@ type PublicKey struct { type FulcioCAWithRekor struct { // fulcioCAData contains inline base64-encoded data for the PEM format fulcio CA. // fulcioCAData must be at most 8192 characters. - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:MaxLength=8192 FulcioCAData []byte `json:"fulcioCAData"` // rekorKeyData contains inline base64-encoded data for the PEM format from the Rekor public key. // rekorKeyData must be at most 8192 characters. - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:MaxLength=8192 RekorKeyData []byte `json:"rekorKeyData"` // fulcioSubject specifies OIDC issuer and the email of the Fulcio authentication configuration. - // +kubebuilder:validation:Required + // +required FulcioSubject PolicyFulcioSubject `json:"fulcioSubject,omitempty"` } @@ -133,12 +133,12 @@ type FulcioCAWithRekor struct { type PolicyFulcioSubject struct { // 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/" - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:XValidation:rule="isURL(self)",message="oidcIssuer must be a valid URL" OIDCIssuer string `json:"oidcIssuer"` // signedEmail holds the email address the the Fulcio certificate is issued for. // Example: "expected-signing-user@example.com" - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:XValidation:rule=`self.matches('^\\S+@\\S+$')`,message="invalid email address" SignedEmail string `json:"signedEmail"` } @@ -157,7 +157,7 @@ type PolicyIdentity struct { // "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. // +unionDiscriminator - // +kubebuilder:validation:Required + // +required MatchPolicy IdentityMatchPolicy `json:"matchPolicy"` // exactRepository is required if matchPolicy is set to "ExactRepository". // +optional @@ -175,7 +175,7 @@ type IdentityRepositoryPrefix string type PolicyMatchExactRepository struct { // 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 - // +kubebuilder:validation:Required + // +required Repository IdentityRepositoryPrefix `json:"repository"` } @@ -186,12 +186,12 @@ type PolicyMatchRemapIdentity struct { // 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. - // +kubebuilder:validation:Required + // +required Prefix IdentityRepositoryPrefix `json:"prefix"` // 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. - // +kubebuilder:validation:Required + // +required SignedPrefix IdentityRepositoryPrefix `json:"signedPrefix"` } diff --git a/config/v1alpha1/types_insights.go b/config/v1alpha1/types_insights.go index 171e96d5b80..3ae4de157cf 100644 --- a/config/v1alpha1/types_insights.go +++ b/config/v1alpha1/types_insights.go @@ -24,7 +24,7 @@ type InsightsDataGather struct { metav1.ObjectMeta `json:"metadata,omitempty"` // spec holds user settable values for configuration - // +kubebuilder:validation:Required + // +required Spec InsightsDataGatherSpec `json:"spec"` // status holds observed values from the cluster. They may not be overridden. // +optional diff --git a/config/v1alpha1/zz_generated.crd-manifests/0000_10_config-operator_01_backups-CustomNoUpgrade.crd.yaml b/config/v1alpha1/zz_generated.crd-manifests/0000_10_config-operator_01_backups-CustomNoUpgrade.crd.yaml index 48a6aa7dcb2..aba325d8834 100644 --- a/config/v1alpha1/zz_generated.crd-manifests/0000_10_config-operator_01_backups-CustomNoUpgrade.crd.yaml +++ b/config/v1alpha1/zz_generated.crd-manifests/0000_10_config-operator_01_backups-CustomNoUpgrade.crd.yaml @@ -51,23 +51,23 @@ spec: properties: pvcName: description: |- - PVCName specifies the name of the PersistentVolumeClaim (PVC) which binds a PersistentVolume where the + 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 retentionPolicy: - description: RetentionPolicy defines the retention policy for + description: retentionPolicy defines the retention policy for retaining and deleting existing backups. properties: retentionNumber: - description: RetentionNumber configures the retention policy + description: retentionNumber configures the retention policy based on the number of backups properties: maxNumberOfBackups: description: |- - MaxNumberOfBackups defines the maximum number of backups to retain. + 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. minimum: 1 @@ -76,12 +76,12 @@ spec: - maxNumberOfBackups type: object retentionSize: - description: RetentionSize configures the retention policy + description: retentionSize configures the retention policy based on the size of backups properties: maxSizeOfBackupsGb: description: |- - MaxSizeOfBackupsGb defines the total size in GB of backups to retain. + 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. minimum: 1 @@ -99,7 +99,7 @@ spec: - RetentionNumber - RetentionSize description: |- - RetentionType sets the type of retention policy. + 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. @@ -109,7 +109,7 @@ spec: type: object schedule: description: |- - Schedule defines the recurring backup schedule in Cron format + 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. diff --git a/config/v1alpha1/zz_generated.crd-manifests/0000_10_config-operator_01_backups-DevPreviewNoUpgrade.crd.yaml b/config/v1alpha1/zz_generated.crd-manifests/0000_10_config-operator_01_backups-DevPreviewNoUpgrade.crd.yaml index 4fa66b80aae..62339318c47 100644 --- a/config/v1alpha1/zz_generated.crd-manifests/0000_10_config-operator_01_backups-DevPreviewNoUpgrade.crd.yaml +++ b/config/v1alpha1/zz_generated.crd-manifests/0000_10_config-operator_01_backups-DevPreviewNoUpgrade.crd.yaml @@ -51,23 +51,23 @@ spec: properties: pvcName: description: |- - PVCName specifies the name of the PersistentVolumeClaim (PVC) which binds a PersistentVolume where the + 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 retentionPolicy: - description: RetentionPolicy defines the retention policy for + description: retentionPolicy defines the retention policy for retaining and deleting existing backups. properties: retentionNumber: - description: RetentionNumber configures the retention policy + description: retentionNumber configures the retention policy based on the number of backups properties: maxNumberOfBackups: description: |- - MaxNumberOfBackups defines the maximum number of backups to retain. + 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. minimum: 1 @@ -76,12 +76,12 @@ spec: - maxNumberOfBackups type: object retentionSize: - description: RetentionSize configures the retention policy + description: retentionSize configures the retention policy based on the size of backups properties: maxSizeOfBackupsGb: description: |- - MaxSizeOfBackupsGb defines the total size in GB of backups to retain. + 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. minimum: 1 @@ -99,7 +99,7 @@ spec: - RetentionNumber - RetentionSize description: |- - RetentionType sets the type of retention policy. + 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. @@ -109,7 +109,7 @@ spec: type: object schedule: description: |- - Schedule defines the recurring backup schedule in Cron format + 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. diff --git a/config/v1alpha1/zz_generated.crd-manifests/0000_10_config-operator_01_backups-TechPreviewNoUpgrade.crd.yaml b/config/v1alpha1/zz_generated.crd-manifests/0000_10_config-operator_01_backups-TechPreviewNoUpgrade.crd.yaml index 41d03aa7b5e..7ce67bdaf35 100644 --- a/config/v1alpha1/zz_generated.crd-manifests/0000_10_config-operator_01_backups-TechPreviewNoUpgrade.crd.yaml +++ b/config/v1alpha1/zz_generated.crd-manifests/0000_10_config-operator_01_backups-TechPreviewNoUpgrade.crd.yaml @@ -51,23 +51,23 @@ spec: properties: pvcName: description: |- - PVCName specifies the name of the PersistentVolumeClaim (PVC) which binds a PersistentVolume where the + 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 retentionPolicy: - description: RetentionPolicy defines the retention policy for + description: retentionPolicy defines the retention policy for retaining and deleting existing backups. properties: retentionNumber: - description: RetentionNumber configures the retention policy + description: retentionNumber configures the retention policy based on the number of backups properties: maxNumberOfBackups: description: |- - MaxNumberOfBackups defines the maximum number of backups to retain. + 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. minimum: 1 @@ -76,12 +76,12 @@ spec: - maxNumberOfBackups type: object retentionSize: - description: RetentionSize configures the retention policy + description: retentionSize configures the retention policy based on the size of backups properties: maxSizeOfBackupsGb: description: |- - MaxSizeOfBackupsGb defines the total size in GB of backups to retain. + 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. minimum: 1 @@ -99,7 +99,7 @@ spec: - RetentionNumber - RetentionSize description: |- - RetentionType sets the type of retention policy. + 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. @@ -109,7 +109,7 @@ spec: type: object schedule: description: |- - Schedule defines the recurring backup schedule in Cron format + 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. diff --git a/config/v1alpha1/zz_generated.featuregated-crd-manifests/backups.config.openshift.io/AutomatedEtcdBackup.yaml b/config/v1alpha1/zz_generated.featuregated-crd-manifests/backups.config.openshift.io/AutomatedEtcdBackup.yaml index ad8e6196540..9a21b5d0528 100644 --- a/config/v1alpha1/zz_generated.featuregated-crd-manifests/backups.config.openshift.io/AutomatedEtcdBackup.yaml +++ b/config/v1alpha1/zz_generated.featuregated-crd-manifests/backups.config.openshift.io/AutomatedEtcdBackup.yaml @@ -51,23 +51,23 @@ spec: properties: pvcName: description: |- - PVCName specifies the name of the PersistentVolumeClaim (PVC) which binds a PersistentVolume where the + 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 retentionPolicy: - description: RetentionPolicy defines the retention policy for + description: retentionPolicy defines the retention policy for retaining and deleting existing backups. properties: retentionNumber: - description: RetentionNumber configures the retention policy + description: retentionNumber configures the retention policy based on the number of backups properties: maxNumberOfBackups: description: |- - MaxNumberOfBackups defines the maximum number of backups to retain. + 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. minimum: 1 @@ -76,12 +76,12 @@ spec: - maxNumberOfBackups type: object retentionSize: - description: RetentionSize configures the retention policy + description: retentionSize configures the retention policy based on the size of backups properties: maxSizeOfBackupsGb: description: |- - MaxSizeOfBackupsGb defines the total size in GB of backups to retain. + 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. minimum: 1 @@ -99,7 +99,7 @@ spec: - RetentionNumber - RetentionSize description: |- - RetentionType sets the type of retention policy. + 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. @@ -109,7 +109,7 @@ spec: type: object schedule: description: |- - Schedule defines the recurring backup schedule in Cron format + 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. diff --git a/config/v1alpha1/zz_generated.swagger_doc_generated.go b/config/v1alpha1/zz_generated.swagger_doc_generated.go index 55468f38dac..e6accce0d72 100644 --- a/config/v1alpha1/zz_generated.swagger_doc_generated.go +++ b/config/v1alpha1/zz_generated.swagger_doc_generated.go @@ -41,10 +41,10 @@ func (BackupSpec) SwaggerDoc() map[string]string { var map_EtcdBackupSpec = map[string]string{ "": "EtcdBackupSpec provides configuration for automated etcd backups to the cluster-etcd-operator", - "schedule": "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.", + "schedule": "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.", "timeZone": "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", - "retentionPolicy": "RetentionPolicy defines the retention policy for retaining and deleting existing backups.", - "pvcName": "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.", + "retentionPolicy": "retentionPolicy defines the retention policy for retaining and deleting existing backups.", + "pvcName": "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.", } func (EtcdBackupSpec) SwaggerDoc() map[string]string { @@ -53,7 +53,7 @@ func (EtcdBackupSpec) SwaggerDoc() map[string]string { var map_RetentionNumberConfig = map[string]string{ "": "RetentionNumberConfig specifies the configuration of the retention policy on the number of backups", - "maxNumberOfBackups": "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.", + "maxNumberOfBackups": "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.", } func (RetentionNumberConfig) SwaggerDoc() map[string]string { @@ -62,9 +62,9 @@ func (RetentionNumberConfig) SwaggerDoc() map[string]string { var map_RetentionPolicy = map[string]string{ "": "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.", - "retentionType": "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.", - "retentionNumber": "RetentionNumber configures the retention policy based on the number of backups", - "retentionSize": "RetentionSize configures the retention policy based on the size of backups", + "retentionType": "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.", + "retentionNumber": "retentionNumber configures the retention policy based on the number of backups", + "retentionSize": "retentionSize configures the retention policy based on the size of backups", } func (RetentionPolicy) SwaggerDoc() map[string]string { @@ -73,7 +73,7 @@ func (RetentionPolicy) SwaggerDoc() map[string]string { var map_RetentionSizeConfig = map[string]string{ "": "RetentionSizeConfig specifies the configuration of the retention policy on the total size of backups", - "maxSizeOfBackupsGb": "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.", + "maxSizeOfBackupsGb": "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.", } func (RetentionSizeConfig) SwaggerDoc() map[string]string { diff --git a/console/v1/types_console_link.go b/console/v1/types_console_link.go index 24a5dbadcdb..977fcbda979 100644 --- a/console/v1/types_console_link.go +++ b/console/v1/types_console_link.go @@ -56,7 +56,7 @@ type ApplicationMenuSpec struct { // 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. Section string `json:"section"` - // imageUrl is the URL for the icon used in front of the link in the application menu. + // 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. // +optional ImageURL string `json:"imageURL,omitempty"` diff --git a/console/v1/types_console_plugin.go b/console/v1/types_console_plugin.go index 534a41ca761..9bb48a81f03 100644 --- a/console/v1/types_console_plugin.go +++ b/console/v1/types_console_plugin.go @@ -26,7 +26,7 @@ type ConsolePlugin struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata"` - // +kubebuilder:validation:Required + // +required Spec ConsolePluginSpec `json:"spec"` } @@ -34,12 +34,12 @@ type ConsolePlugin struct { type ConsolePluginSpec struct { // displayName is the display name of the plugin. // The dispalyName should be between 1 and 128 characters. - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=128 DisplayName string `json:"displayName"` // backend holds the configuration of backend which is serving console's plugin . - // +kubebuilder:validation:Required + // +required Backend ConsolePluginBackend `json:"backend"` // proxy is a list of proxies that describe various service type // to which the plugin needs to connect to. @@ -158,7 +158,7 @@ type ConsolePluginCSP struct { // 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 - // +kubebuilder:validation:Required + // +required Directive DirectiveType `json:"directive"` // 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 @@ -168,7 +168,7 @@ type ConsolePluginCSP struct { // quotes ('). The value '*' is not permitted. // Each value in the array must be unique. // - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:MinItems=1 // +kubebuilder:validation:MaxItems=16 // +kubebuilder:validation:XValidation:rule="self.all(x, self.exists_one(y, x == y))",message="each CSP directive value must be unique" @@ -201,7 +201,7 @@ type ConsolePluginI18n struct { // 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. - // +kubebuilder:validation:Required + // +required LoadType LoadType `json:"loadType"` } @@ -209,7 +209,7 @@ type ConsolePluginI18n struct { // to which console's backend will proxy the plugin's requests. type ConsolePluginProxy struct { // endpoint provides information about endpoint to which the request is proxied to. - // +kubebuilder:validation:Required + // +required Endpoint ConsolePluginProxyEndpoint `json:"endpoint"` // alias is a proxy name that identifies the plugin's proxy. An alias name // should be unique per plugin. The console backend exposes following @@ -221,7 +221,7 @@ type ConsolePluginProxy struct { // // /api/proxy/plugin/acm/search/pods?namespace=openshift-apiserver // - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=128 // +kubebuilder:validation:Pattern=`^[A-Za-z0-9-_]+$` @@ -248,7 +248,7 @@ type ConsolePluginProxyEndpoint struct { // --- // + When handling unknown values, consumers should report an error and stop processing the plugin. // - // +kubebuilder:validation:Required + // +required // +unionDiscriminator Type ConsolePluginProxyType `json:"type"` // service is an in-cluster Service that the plugin will connect to. @@ -288,18 +288,18 @@ const ( // console's backend will proxy the plugin's requests. type ConsolePluginProxyServiceConfig struct { // name of Service that the plugin needs to connect to. - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=128 Name string `json:"name"` // namespace of Service that the plugin needs to connect to - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=128 Namespace string `json:"namespace"` // port on which the Service that the plugin needs to connect to // is listening on. - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:Maximum:=65535 // +kubebuilder:validation:Minimum:=1 Port int32 `json:"port"` @@ -323,7 +323,7 @@ type ConsolePluginBackend struct { // --- // + When handling unknown values, consumers should report an error and stop processing the plugin. // - // +kubebuilder:validation:Required + // +required // +unionDiscriminator Type ConsolePluginBackendType `json:"type"` // service is a Kubernetes Service that exposes the plugin using a @@ -338,17 +338,17 @@ type ConsolePluginBackend struct { // console dynamic plugin assets. type ConsolePluginService struct { // name of Service that is serving the plugin assets. - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=128 Name string `json:"name"` // namespace of Service that is serving the plugin assets. - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=128 Namespace string `json:"namespace"` // port on which the Service that is serving the plugin is listening to. - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:Maximum:=65535 // +kubebuilder:validation:Minimum:=1 Port int32 `json:"port"` diff --git a/console/v1/types_console_quick_start.go b/console/v1/types_console_quick_start.go index bb62fb8fc8e..1eef701e8b6 100644 --- a/console/v1/types_console_quick_start.go +++ b/console/v1/types_console_quick_start.go @@ -28,7 +28,6 @@ type ConsoleQuickStart struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata,omitempty"` - // +kubebuilder:validation:Required // +required Spec ConsoleQuickStartSpec `json:"spec"` } @@ -36,7 +35,6 @@ type ConsoleQuickStart struct { // ConsoleQuickStartSpec is the desired quick start configuration. type ConsoleQuickStartSpec struct { // displayName is the display name of the Quick Start. - // +kubebuilder:validation:Required // +kubebuilder:validation:MinLength=1 // +required DisplayName string `json:"displayName"` @@ -48,12 +46,10 @@ type ConsoleQuickStartSpec struct { // +optional Tags []string `json:"tags,omitempty"` // durationMinutes describes approximately how many minutes it will take to complete the Quick Start. - // +kubebuilder:validation:Required // +kubebuilder:validation:Minimum=1 // +required DurationMinutes int `json:"durationMinutes"` // description is the description of the Quick Start. (includes markdown) - // +kubebuilder:validation:Required // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=256 // +required @@ -62,12 +58,10 @@ type ConsoleQuickStartSpec struct { // +optional Prerequisites []string `json:"prerequisites,omitempty"` // introduction describes the purpose of the Quick Start. (includes markdown) - // +kubebuilder:validation:Required // +kubebuilder:validation:MinLength=1 // +required Introduction string `json:"introduction"` // tasks is the list of steps the user has to perform to complete the Quick Start. - // +kubebuilder:validation:Required // +kubebuilder:validation:MinItems=1 // +required Tasks []ConsoleQuickStartTask `json:"tasks"` @@ -87,12 +81,10 @@ type ConsoleQuickStartSpec struct { // ConsoleQuickStartTask is a single step in a Quick Start. type ConsoleQuickStartTask struct { // title describes the task and is displayed as a step heading. - // +kubebuilder:validation:Required // +kubebuilder:validation:MinLength=1 // +required Title string `json:"title"` // description describes the steps needed to complete the task. (includes markdown) - // +kubebuilder:validation:Required // +kubebuilder:validation:MinLength=1 // +required Description string `json:"description"` @@ -109,12 +101,10 @@ type ConsoleQuickStartTask struct { type ConsoleQuickStartTaskReview struct { // instructions contains steps that user needs to take in order // to validate his work after going through a task. (includes markdown) - // +kubebuilder:validation:Required // +kubebuilder:validation:MinLength=1 // +required Instructions string `json:"instructions"` // failedTaskHelp contains suggestions for a failed task review and is shown at the end of task. (includes markdown) - // +kubebuilder:validation:Required // +kubebuilder:validation:MinLength=1 // +required FailedTaskHelp string `json:"failedTaskHelp"` @@ -123,12 +113,10 @@ type ConsoleQuickStartTaskReview struct { // ConsoleQuickStartTaskSummary contains information about a passed step. type ConsoleQuickStartTaskSummary struct { // success describes the succesfully passed task. - // +kubebuilder:validation:Required // +kubebuilder:validation:MinLength=1 // +required Success string `json:"success"` // failed briefly describes the unsuccessfully passed task. (includes markdown) - // +kubebuilder:validation:Required // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=128 // +required diff --git a/console/v1/types_console_sample.go b/console/v1/types_console_sample.go index c0175bf9ba6..bd0f6569699 100644 --- a/console/v1/types_console_sample.go +++ b/console/v1/types_console_sample.go @@ -25,7 +25,7 @@ type ConsoleSample struct { metav1.ObjectMeta `json:"metadata"` // spec contains configuration for a console sample. - // +kubebuilder:validation:Required + // +required Spec ConsoleSampleSpec `json:"spec"` } @@ -35,7 +35,7 @@ type ConsoleSampleSpec struct { // title is the display name of the sample. // // It is required and must be no more than 50 characters in length. - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=50 Title string `json:"title"` @@ -46,7 +46,7 @@ type ConsoleSampleSpec struct { // // The abstract is shown on the sample card tile below the title and provider // and is limited to three lines of content. - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:MaxLength=100 Abstract string `json:"abstract"` @@ -56,7 +56,7 @@ type ConsoleSampleSpec struct { // // It 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. - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:MaxLength=4096 Description string `json:"description"` @@ -119,7 +119,7 @@ type ConsoleSampleSpec struct { // source defines where to deploy the sample service from. // The sample may be sourced from an external git repository or container image. - // +kubebuilder:validation:Required + // +required Source ConsoleSampleSource `json:"source"` } @@ -143,7 +143,7 @@ const ( type ConsoleSampleSource struct { // type of the sample, currently supported: "GitImport";"ContainerImport" // +unionDiscriminator - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:Enum:="GitImport";"ContainerImport" Type ConsoleSampleSourceType `json:"type"` @@ -161,7 +161,7 @@ type ConsoleSampleSource struct { // ConsoleSampleGitImportSource let the user import code from a public Git repository. type ConsoleSampleGitImportSource struct { // repository contains the reference to the actual Git repository. - // +kubebuilder:validation:Required + // +required Repository ConsoleSampleGitImportSourceRepository `json:"repository"` // service contains configuration for the Service resource created for this sample. // +optional @@ -183,7 +183,7 @@ type ConsoleSampleGitImportSourceRepository struct { // - https://bitbucket.org// // // The url must have a maximum length of 256 characters. - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=256 // +kubebuilder:validation:Pattern=`^https:\/\/(github.com|gitlab.com|bitbucket.org)\/[a-zA-Z0-9-]+\/[a-zA-Z0-9-]+(.git)?$` @@ -232,7 +232,7 @@ type ConsoleSampleContainerImportSource struct { // - quay.io// // - quay.io//@sha256: // - quay.io//: - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=256 Image string `json:"image"` diff --git a/console/v1/zz_generated.crd-manifests/00_consolelinks.crd.yaml b/console/v1/zz_generated.crd-manifests/00_consolelinks.crd.yaml index de1d9671552..e687ff84050 100644 --- a/console/v1/zz_generated.crd-manifests/00_consolelinks.crd.yaml +++ b/console/v1/zz_generated.crd-manifests/00_consolelinks.crd.yaml @@ -67,7 +67,7 @@ spec: properties: imageURL: description: |- - imageUrl is the URL for the icon used in front of the link in the application menu. + 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: diff --git a/console/v1/zz_generated.featuregated-crd-manifests/consolelinks.console.openshift.io/AAA_ungated.yaml b/console/v1/zz_generated.featuregated-crd-manifests/consolelinks.console.openshift.io/AAA_ungated.yaml index a16629a52b9..59b522beed9 100644 --- a/console/v1/zz_generated.featuregated-crd-manifests/consolelinks.console.openshift.io/AAA_ungated.yaml +++ b/console/v1/zz_generated.featuregated-crd-manifests/consolelinks.console.openshift.io/AAA_ungated.yaml @@ -66,7 +66,7 @@ spec: properties: imageURL: description: |- - imageUrl is the URL for the icon used in front of the link in the application menu. + 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: diff --git a/console/v1/zz_generated.swagger_doc_generated.go b/console/v1/zz_generated.swagger_doc_generated.go index 685cb7ea276..763c9781c6c 100644 --- a/console/v1/zz_generated.swagger_doc_generated.go +++ b/console/v1/zz_generated.swagger_doc_generated.go @@ -91,7 +91,7 @@ func (ConsoleExternalLogLinkSpec) SwaggerDoc() map[string]string { var map_ApplicationMenuSpec = map[string]string{ "": "ApplicationMenuSpec is the specification of the desired section and icon used for the link in the application menu.", "section": "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.", - "imageURL": "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.", + "imageURL": "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.", } func (ApplicationMenuSpec) SwaggerDoc() map[string]string { diff --git a/example/v1/types_stable.go b/example/v1/types_stable.go index e6ceabc9603..21ee169d0db 100644 --- a/example/v1/types_stable.go +++ b/example/v1/types_stable.go @@ -36,7 +36,6 @@ type StableConfigType struct { type StableConfigTypeSpec struct { // coolNewField is a field that is for tech preview only. On normal clusters this shouldn't be present // - // +kubebuilder:validation:Optional // +openshift:enable:FeatureGate=Example // +optional CoolNewField string `json:"coolNewField"` @@ -51,7 +50,7 @@ type StableConfigTypeSpec struct { // immutableField is a field that is immutable once the object has been created. // It is required at all times. // +kubebuilder:validation:XValidation:rule="self == oldSelf",message="immutableField is immutable" - // +kubebuilder:validation:Required + // +required ImmutableField string `json:"immutableField"` // optionalImmutableField is a field that is immutable once set. @@ -110,7 +109,7 @@ type StringSet []SetValue type EvolvingUnion struct { // type is the discriminator. It has different values for Default and for TechPreviewNoUpgrade - // +kubebuilder:validation:Required + // +required Type EvolvingDiscriminator `json:"type,omitempty"` } @@ -133,7 +132,7 @@ const ( // +union type CELUnion struct { // type determines which of the union members should be populated. - // +kubebuilder:validation:Required + // +required // +unionDiscriminator Type CELUnionDiscriminator `json:"type,omitempty"` diff --git a/example/v1alpha1/types_notstable.go b/example/v1alpha1/types_notstable.go index b9ea0057966..08f239325f4 100644 --- a/example/v1alpha1/types_notstable.go +++ b/example/v1alpha1/types_notstable.go @@ -34,7 +34,7 @@ type NotStableConfigType struct { type NotStableConfigTypeSpec struct { // newField is a field that is tech preview, but because the entire type is gated, there is no marker on the field. // - // +kubebuilder:validation:Required + // +required NewField string `json:"newField"` } diff --git a/helm/v1beta1/types_helm_chart_repository.go b/helm/v1beta1/types_helm_chart_repository.go index 91f25fb6734..4700f911405 100644 --- a/helm/v1beta1/types_helm_chart_repository.go +++ b/helm/v1beta1/types_helm_chart_repository.go @@ -27,7 +27,6 @@ type HelmChartRepository struct { metav1.ObjectMeta `json:"metadata,omitempty"` // spec holds user settable values for configuration - // +kubebuilder:validation:Required // +required Spec HelmChartRepositorySpec `json:"spec"` diff --git a/helm/v1beta1/types_project_helm_chart_repository.go b/helm/v1beta1/types_project_helm_chart_repository.go index 37ff581c14f..8049c4fe5e2 100644 --- a/helm/v1beta1/types_project_helm_chart_repository.go +++ b/helm/v1beta1/types_project_helm_chart_repository.go @@ -26,7 +26,6 @@ type ProjectHelmChartRepository struct { metav1.ObjectMeta `json:"metadata,omitempty"` // spec holds user settable values for configuration - // +kubebuilder:validation:Required // +required Spec ProjectHelmChartRepositorySpec `json:"spec"` diff --git a/image/v1/generated.proto b/image/v1/generated.proto index 6b5f24cb21a..dabdc6d84a5 100644 --- a/image/v1/generated.proto +++ b/image/v1/generated.proto @@ -47,39 +47,39 @@ message Image { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata optional .k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1; - // DockerImageReference is the string that can be used to pull this image. + // dockerImageReference is the string that can be used to pull this image. optional string dockerImageReference = 2; - // DockerImageMetadata contains metadata about this image + // dockerImageMetadata contains metadata about this image // +patchStrategy=replace // +kubebuilder:pruning:PreserveUnknownFields optional .k8s.io.apimachinery.pkg.runtime.RawExtension dockerImageMetadata = 3; - // DockerImageMetadataVersion conveys the version of the object, which if empty defaults to "1.0" + // dockerImageMetadataVersion conveys the version of the object, which if empty defaults to "1.0" optional string dockerImageMetadataVersion = 4; - // DockerImageManifest is the raw JSON of the manifest + // dockerImageManifest is the raw JSON of the manifest optional string dockerImageManifest = 5; - // 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. + // 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. repeated ImageLayer dockerImageLayers = 6; - // Signatures holds all signatures of the image. + // signatures holds all signatures of the image. // +patchMergeKey=name // +patchStrategy=merge repeated ImageSignature signatures = 7; - // DockerImageSignatures provides the signatures as opaque blobs. This is a part of manifest schema v1. + // dockerImageSignatures provides the signatures as opaque blobs. This is a part of manifest schema v1. repeated bytes dockerImageSignatures = 8; - // DockerImageManifestMediaType specifies the mediaType of manifest. This is a part of manifest schema v2. + // dockerImageManifestMediaType specifies the mediaType of manifest. This is a part of manifest schema v2. optional string dockerImageManifestMediaType = 9; - // DockerImageConfig is a JSON blob that the runtime uses to set up the container. This is a part of manifest schema v2. + // 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. optional string dockerImageConfig = 10; - // DockerImageManifests holds information about sub-manifests when the image represents a manifest list. + // dockerImageManifests holds information about sub-manifests when the image represents a manifest list. // When this field is present, no DockerImageLayers should be specified. repeated ImageManifest dockerImageManifests = 11; } @@ -114,56 +114,56 @@ message ImageBlobReferences { // ImageImportSpec describes a request to import a specific image. message ImageImportSpec { - // From is the source of an image to import; only kind DockerImage is allowed + // from is the source of an image to import; only kind DockerImage is allowed optional .k8s.io.api.core.v1.ObjectReference from = 1; - // 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 + // 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 optional .k8s.io.api.core.v1.LocalObjectReference to = 2; - // ImportPolicy is the policy controlling how the image is imported + // importPolicy is the policy controlling how the image is imported optional TagImportPolicy importPolicy = 3; - // ReferencePolicy defines how other components should consume the image + // referencePolicy defines how other components should consume the image optional TagReferencePolicy referencePolicy = 5; - // IncludeManifest determines if the manifest for each image is returned in the response + // includeManifest determines if the manifest for each image is returned in the response optional bool includeManifest = 4; } // ImageImportStatus describes the result of an image import. message ImageImportStatus { - // Status is the status of the image import, including errors encountered while retrieving the image + // status is the status of the image import, including errors encountered while retrieving the image optional .k8s.io.apimachinery.pkg.apis.meta.v1.Status status = 1; - // Image is the metadata of that image, if the image was located + // image is the metadata of that image, if the image was located optional Image image = 2; - // Tag is the tag this image was located under, if any + // tag is the tag this image was located under, if any optional string tag = 3; - // Manifests holds sub-manifests metadata when importing a manifest list + // manifests holds sub-manifests metadata when importing a manifest list repeated Image manifests = 4; } // ImageLayer represents a single layer of the image. Some images may have multiple layers. Some may have none. message ImageLayer { - // Name of the layer as defined by the underlying store. + // name of the layer as defined by the underlying store. optional string name = 1; - // Size of the layer in bytes as defined by the underlying store. + // size of the layer in bytes as defined by the underlying store. optional int64 size = 2; - // MediaType of the referenced object. + // mediaType of the referenced object. optional string mediaType = 3; } // ImageLayerData contains metadata about an image layer. message ImageLayerData { - // Size of the layer in bytes as defined by the underlying store. This field is + // 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. optional int64 size = 1; - // MediaType of the referenced object. + // mediaType of the referenced object. optional string mediaType = 2; } @@ -176,7 +176,7 @@ message ImageList { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata optional .k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1; - // Items is a list of images + // items is a list of images repeated Image items = 2; } @@ -194,23 +194,23 @@ message ImageLookupPolicy { // ImageManifest represents sub-manifests of a manifest list. The Digest field points to a regular // Image object. message ImageManifest { - // Digest is the unique identifier for the manifest. It refers to an Image object. + // digest is the unique identifier for the manifest. It refers to an Image object. optional string digest = 1; - // MediaType defines the type of the manifest, possible values are application/vnd.oci.image.manifest.v1+json, + // 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. optional string mediaType = 2; - // ManifestSize represents the size of the raw object contents, in bytes. + // manifestSize represents the size of the raw object contents, in bytes. optional int64 manifestSize = 3; - // Architecture specifies the supported CPU architecture, for example `amd64` or `ppc64le`. + // architecture specifies the supported CPU architecture, for example `amd64` or `ppc64le`. optional string architecture = 4; - // OS specifies the operating system, for example `linux`. + // os specifies the operating system, for example `linux`. optional string os = 5; - // Variant is an optional field repreenting a variant of the CPU, for example v6 to specify a particular CPU + // variant is an optional field repreenting a variant of the CPU, for example v6 to specify a particular CPU // variant of the ARM CPU. optional string variant = 6; } @@ -234,7 +234,7 @@ message ImageSignature { // Required: An opaque binary string which is an image's signature. optional bytes content = 3; - // Conditions represent the latest available observations of a signature's current state. + // conditions represent the latest available observations of a signature's current state. // +patchMergeKey=type // +patchStrategy=merge repeated SignatureCondition conditions = 4; @@ -280,11 +280,11 @@ message ImageStream { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata optional .k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1; - // Spec describes the desired state of this stream + // spec describes the desired state of this stream // +optional optional ImageStreamSpec spec = 2; - // Status describes the current state of this stream + // status describes the current state of this stream // +optional optional ImageStreamStatus status = 3; } @@ -309,7 +309,7 @@ message ImageStreamImage { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata optional .k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1; - // Image associated with the ImageStream and image name. + // image associated with the ImageStream and image name. optional Image image = 2; } @@ -329,36 +329,36 @@ message ImageStreamImport { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata optional .k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1; - // Spec is a description of the images that the user wishes to import + // spec is a description of the images that the user wishes to import optional ImageStreamImportSpec spec = 2; - // Status is the result of importing the image + // status is the result of importing the image optional ImageStreamImportStatus status = 3; } // ImageStreamImportSpec defines what images should be imported. message ImageStreamImportSpec { - // Import indicates whether to perform an import - if so, the specified tags are set on the spec + // 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. optional bool import = 1; - // Repository is an optional import of an entire container image repository. A maximum limit on the + // 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. optional RepositoryImportSpec repository = 2; - // Images are a list of individual images to import. + // images are a list of individual images to import. repeated ImageImportSpec images = 3; } // ImageStreamImportStatus contains information about the status of an image stream import. message ImageStreamImportStatus { - // Import is the image stream that was successfully updated or created when 'to' was set. + // import is the image stream that was successfully updated or created when 'to' was set. optional ImageStream import = 1; - // Repository is set if spec.repository was set to the outcome of the import + // repository is set if spec.repository was set to the outcome of the import optional RepositoryImportStatus repository = 2; - // Images is set with the result of importing spec.images + // images is set with the result of importing spec.images repeated ImageImportStatus images = 3; } @@ -389,7 +389,7 @@ message ImageStreamList { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata optional .k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1; - // Items is a list of imageStreams + // items is a list of imageStreams repeated ImageStream items = 2; } @@ -409,10 +409,10 @@ message ImageStreamMapping { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata optional .k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1; - // Image is a container image. + // image is a container image. optional Image image = 2; - // Tag is a string value this image can be located with inside the stream. + // tag is a string value this image can be located with inside the stream. optional string tag = 3; } @@ -434,16 +434,16 @@ message ImageStreamSpec { // ImageStreamStatus contains information about the state of this image stream. message ImageStreamStatus { - // DockerImageRepository represents the effective location this stream may be accessed at. + // dockerImageRepository represents the effective location this stream may be accessed at. // May be empty until the server determines where the repository is located optional string dockerImageRepository = 1; - // PublicDockerImageRepository represents the public location from where the image can + // 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. optional string publicDockerImageRepository = 3; - // Tags are a historical record of images associated with each tag. The first entry in the + // tags are a historical record of images associated with each tag. The first entry in the // TagEvent array is the currently tagged image. // +patchMergeKey=tag // +patchStrategy=merge @@ -496,7 +496,7 @@ message ImageStreamTagList { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata optional .k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1; - // Items is the list of image stream tags + // items is the list of image stream tags repeated ImageStreamTag items = 2; } @@ -543,46 +543,46 @@ message ImageTagList { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata optional .k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1; - // Items is the list of image stream tags + // items is the list of image stream tags repeated ImageTag items = 2; } // NamedTagEventList relates a tag to its image history. message NamedTagEventList { - // Tag is the tag for which the history is recorded + // tag is the tag for which the history is recorded optional string tag = 1; // Standard object's metadata. repeated TagEvent items = 2; - // Conditions is an array of conditions that apply to the tag event list. + // conditions is an array of conditions that apply to the tag event list. repeated TagEventCondition conditions = 3; } // RepositoryImportSpec describes a request to import images from a container image repository. message RepositoryImportSpec { - // From is the source for the image repository to import; only kind DockerImage and a name of a container image repository is allowed + // from is the source for the image repository to import; only kind DockerImage and a name of a container image repository is allowed optional .k8s.io.api.core.v1.ObjectReference from = 1; - // ImportPolicy is the policy controlling how the image is imported + // importPolicy is the policy controlling how the image is imported optional TagImportPolicy importPolicy = 2; - // ReferencePolicy defines how other components should consume the image + // referencePolicy defines how other components should consume the image optional TagReferencePolicy referencePolicy = 4; - // IncludeManifest determines if the manifest for each image is returned in the response + // includeManifest determines if the manifest for each image is returned in the response optional bool includeManifest = 3; } // RepositoryImportStatus describes the result of an image repository import message RepositoryImportStatus { - // Status reflects whether any failure occurred during import + // status reflects whether any failure occurred during import optional .k8s.io.apimachinery.pkg.apis.meta.v1.Status status = 1; - // Images is a list of images successfully retrieved by the import of the repository. + // images is a list of images successfully retrieved by the import of the repository. repeated ImageImportStatus images = 2; - // AdditionalTags are tags that exist in the repository but were not imported because + // additionalTags are tags that exist in the repository but were not imported because // a maximum limit of automatic imports was applied. repeated string additionalTags = 3; } @@ -602,10 +602,10 @@ message SecretList { // SignatureCondition describes an image signature condition of particular kind at particular probe time. message SignatureCondition { - // Type of signature condition, Complete or Failed. + // type of signature condition, Complete or Failed. optional string type = 1; - // Status of the condition, one of True, False, Unknown. + // status of the condition, one of True, False, Unknown. optional string status = 2; // Last time the condition was checked. @@ -624,7 +624,7 @@ message SignatureCondition { // SignatureGenericEntity holds a generic information about a person or entity who is an issuer or a subject // of signing certificate or key. message SignatureGenericEntity { - // Organization name. + // organization name. optional string organization = 1; // Common name (e.g. openshift-signing-service). @@ -648,55 +648,55 @@ message SignatureSubject { // TagEvent is used by ImageStreamStatus to keep a historical record of images associated with a tag. message TagEvent { - // Created holds the time the TagEvent was created + // created holds the time the TagEvent was created optional .k8s.io.apimachinery.pkg.apis.meta.v1.Time created = 1; - // DockerImageReference is the string that can be used to pull this image + // dockerImageReference is the string that can be used to pull this image optional string dockerImageReference = 2; - // Image is the image + // image is the image optional string image = 3; - // Generation is the spec tag generation that resulted in this tag being updated + // generation is the spec tag generation that resulted in this tag being updated optional int64 generation = 4; } // TagEventCondition contains condition information for a tag event. message TagEventCondition { - // Type of tag event condition, currently only ImportSuccess + // type of tag event condition, currently only ImportSuccess optional string type = 1; - // Status of the condition, one of True, False, Unknown. + // status of the condition, one of True, False, Unknown. optional string status = 2; - // LastTransitionTIme is the time the condition transitioned from one status to another. + // lastTransitionTime is the time the condition transitioned from one status to another. optional .k8s.io.apimachinery.pkg.apis.meta.v1.Time lastTransitionTime = 3; - // Reason is a brief machine readable explanation for the condition's last transition. + // reason is a brief machine readable explanation for the condition's last transition. optional string reason = 4; - // Message is a human readable description of the details about last transition, complementing reason. + // message is a human readable description of the details about last transition, complementing reason. optional string message = 5; - // Generation is the spec tag generation that this status corresponds to + // generation is the spec tag generation that this status corresponds to optional int64 generation = 6; } // TagImportPolicy controls how images related to this tag will be imported. message TagImportPolicy { - // Insecure is true if the server may bypass certificate verification or connect directly over HTTP during image import. + // insecure is true if the server may bypass certificate verification or connect directly over HTTP during image import. optional bool insecure = 1; - // Scheduled indicates to the server that this tag should be periodically checked to ensure it is up to date, and imported + // scheduled indicates to the server that this tag should be periodically checked to ensure it is up to date, and imported optional bool scheduled = 2; - // ImportMode describes how to import an image manifest. + // importMode describes how to import an image manifest. optional string importMode = 3; } // TagReference specifies optional annotations for images using this tag and an optional reference to an ImageStreamTag, ImageStreamImage, or DockerImage this tag should track. message TagReference { - // Name of the tag + // name of the tag optional string name = 1; // Optional; if specified, annotations that are applied to images retrieved via ImageStreamTags. @@ -708,11 +708,11 @@ message TagReference { // can only reference a tag within this same ImageStream. optional .k8s.io.api.core.v1.ObjectReference from = 3; - // Reference states if the tag will be imported. Default value is false, which means the tag will + // reference states if the tag will be imported. Default value is false, which means the tag will // be imported. optional bool reference = 4; - // Generation is a counter that tracks mutations to the spec tag (user intent). When a tag reference + // 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 @@ -722,10 +722,10 @@ message TagReference { // +optional optional int64 generation = 5; - // ImportPolicy is information that controls how images may be imported by the server. + // importPolicy is information that controls how images may be imported by the server. optional TagImportPolicy importPolicy = 6; - // ReferencePolicy defines how other components should consume the image. + // referencePolicy defines how other components should consume the image. optional TagReferencePolicy referencePolicy = 7; } @@ -733,7 +733,7 @@ message TagReference { // image change triggers in deployment configs or builds are resolved. This allows the image stream // author to control how images are accessed. message TagReferencePolicy { - // Type determines how the image pull spec should be transformed when the image stream tag is used in + // 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 diff --git a/image/v1/types.go b/image/v1/types.go index 9919c0fe764..d4ee4bff697 100644 --- a/image/v1/types.go +++ b/image/v1/types.go @@ -19,7 +19,7 @@ type ImageList struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` - // Items is a list of images + // items is a list of images Items []Image `json:"items" protobuf:"bytes,2,rep,name=items"` } @@ -45,30 +45,30 @@ type Image struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` - // DockerImageReference is the string that can be used to pull this image. + // dockerImageReference is the string that can be used to pull this image. DockerImageReference string `json:"dockerImageReference,omitempty" protobuf:"bytes,2,opt,name=dockerImageReference"` - // DockerImageMetadata contains metadata about this image + // dockerImageMetadata contains metadata about this image // +patchStrategy=replace // +kubebuilder:pruning:PreserveUnknownFields DockerImageMetadata runtime.RawExtension `json:"dockerImageMetadata,omitempty" patchStrategy:"replace" protobuf:"bytes,3,opt,name=dockerImageMetadata"` - // DockerImageMetadataVersion conveys the version of the object, which if empty defaults to "1.0" + // dockerImageMetadataVersion conveys the version of the object, which if empty defaults to "1.0" DockerImageMetadataVersion string `json:"dockerImageMetadataVersion,omitempty" protobuf:"bytes,4,opt,name=dockerImageMetadataVersion"` - // DockerImageManifest is the raw JSON of the manifest + // dockerImageManifest is the raw JSON of the manifest DockerImageManifest string `json:"dockerImageManifest,omitempty" protobuf:"bytes,5,opt,name=dockerImageManifest"` - // 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. + // 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. DockerImageLayers []ImageLayer `json:"dockerImageLayers,omitempty" protobuf:"bytes,6,rep,name=dockerImageLayers"` - // Signatures holds all signatures of the image. + // signatures holds all signatures of the image. // +patchMergeKey=name // +patchStrategy=merge Signatures []ImageSignature `json:"signatures,omitempty" patchStrategy:"merge" patchMergeKey:"name" protobuf:"bytes,7,rep,name=signatures"` - // DockerImageSignatures provides the signatures as opaque blobs. This is a part of manifest schema v1. + // dockerImageSignatures provides the signatures as opaque blobs. This is a part of manifest schema v1. DockerImageSignatures [][]byte `json:"dockerImageSignatures,omitempty" protobuf:"bytes,8,rep,name=dockerImageSignatures"` - // DockerImageManifestMediaType specifies the mediaType of manifest. This is a part of manifest schema v2. + // dockerImageManifestMediaType specifies the mediaType of manifest. This is a part of manifest schema v2. DockerImageManifestMediaType string `json:"dockerImageManifestMediaType,omitempty" protobuf:"bytes,9,opt,name=dockerImageManifestMediaType"` - // DockerImageConfig is a JSON blob that the runtime uses to set up the container. This is a part of manifest schema v2. + // 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. DockerImageConfig string `json:"dockerImageConfig,omitempty" protobuf:"bytes,10,opt,name=dockerImageConfig"` - // DockerImageManifests holds information about sub-manifests when the image represents a manifest list. + // dockerImageManifests holds information about sub-manifests when the image represents a manifest list. // When this field is present, no DockerImageLayers should be specified. DockerImageManifests []ImageManifest `json:"dockerImageManifests,omitempty" protobuf:"bytes,11,rep,name=dockerImageManifests"` } @@ -76,29 +76,29 @@ type Image struct { // ImageManifest represents sub-manifests of a manifest list. The Digest field points to a regular // Image object. type ImageManifest struct { - // Digest is the unique identifier for the manifest. It refers to an Image object. + // digest is the unique identifier for the manifest. It refers to an Image object. Digest string `json:"digest" protobuf:"bytes,1,opt,name=digest"` - // MediaType defines the type of the manifest, possible values are application/vnd.oci.image.manifest.v1+json, + // 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. MediaType string `json:"mediaType" protobuf:"bytes,2,opt,name=mediaType"` - // ManifestSize represents the size of the raw object contents, in bytes. + // manifestSize represents the size of the raw object contents, in bytes. ManifestSize int64 `json:"manifestSize" protobuf:"varint,3,opt,name=manifestSize"` - // Architecture specifies the supported CPU architecture, for example `amd64` or `ppc64le`. + // architecture specifies the supported CPU architecture, for example `amd64` or `ppc64le`. Architecture string `json:"architecture" protobuf:"bytes,4,opt,name=architecture"` - // OS specifies the operating system, for example `linux`. + // os specifies the operating system, for example `linux`. OS string `json:"os" protobuf:"bytes,5,opt,name=os"` - // Variant is an optional field repreenting a variant of the CPU, for example v6 to specify a particular CPU + // variant is an optional field repreenting a variant of the CPU, for example v6 to specify a particular CPU // variant of the ARM CPU. Variant string `json:"variant,omitempty" protobuf:"bytes,6,opt,name=variant"` } // ImageLayer represents a single layer of the image. Some images may have multiple layers. Some may have none. type ImageLayer struct { - // Name of the layer as defined by the underlying store. + // name of the layer as defined by the underlying store. Name string `json:"name" protobuf:"bytes,1,opt,name=name"` - // Size of the layer in bytes as defined by the underlying store. + // size of the layer in bytes as defined by the underlying store. LayerSize int64 `json:"size" protobuf:"varint,2,opt,name=size"` - // MediaType of the referenced object. + // mediaType of the referenced object. MediaType string `json:"mediaType" protobuf:"bytes,3,opt,name=mediaType"` } @@ -126,7 +126,7 @@ type ImageSignature struct { Type string `json:"type" protobuf:"bytes,2,opt,name=type"` // Required: An opaque binary string which is an image's signature. Content []byte `json:"content" protobuf:"bytes,3,opt,name=content"` - // Conditions represent the latest available observations of a signature's current state. + // conditions represent the latest available observations of a signature's current state. // +patchMergeKey=type // +patchStrategy=merge Conditions []SignatureCondition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,4,rep,name=conditions"` @@ -154,9 +154,9 @@ type SignatureConditionType string // SignatureCondition describes an image signature condition of particular kind at particular probe time. type SignatureCondition struct { - // Type of signature condition, Complete or Failed. + // type of signature condition, Complete or Failed. Type SignatureConditionType `json:"type" protobuf:"bytes,1,opt,name=type,casttype=SignatureConditionType"` - // Status of the condition, one of True, False, Unknown. + // status of the condition, one of True, False, Unknown. Status corev1.ConditionStatus `json:"status" protobuf:"bytes,2,opt,name=status,casttype=k8s.io/api/core/v1.ConditionStatus"` // Last time the condition was checked. LastProbeTime metav1.Time `json:"lastProbeTime,omitempty" protobuf:"bytes,3,opt,name=lastProbeTime"` @@ -171,7 +171,7 @@ type SignatureCondition struct { // SignatureGenericEntity holds a generic information about a person or entity who is an issuer or a subject // of signing certificate or key. type SignatureGenericEntity struct { - // Organization name. + // organization name. Organization string `json:"organization,omitempty" protobuf:"bytes,1,opt,name=organization"` // Common name (e.g. openshift-signing-service). CommonName string `json:"commonName,omitempty" protobuf:"bytes,2,opt,name=commonName"` @@ -204,7 +204,7 @@ type ImageStreamList struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` - // Items is a list of imageStreams + // items is a list of imageStreams Items []ImageStream `json:"items" protobuf:"bytes,2,rep,name=items"` } @@ -237,10 +237,10 @@ type ImageStream struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` - // Spec describes the desired state of this stream + // spec describes the desired state of this stream // +optional Spec ImageStreamSpec `json:"spec" protobuf:"bytes,2,opt,name=spec"` - // Status describes the current state of this stream + // status describes the current state of this stream // +optional Status ImageStreamStatus `json:"status,omitempty" protobuf:"bytes,3,opt,name=status"` } @@ -272,7 +272,7 @@ type ImageLookupPolicy struct { // TagReference specifies optional annotations for images using this tag and an optional reference to an ImageStreamTag, ImageStreamImage, or DockerImage this tag should track. type TagReference struct { - // Name of the tag + // name of the tag Name string `json:"name" protobuf:"bytes,1,opt,name=name"` // Optional; if specified, annotations that are applied to images retrieved via ImageStreamTags. // +optional @@ -281,10 +281,10 @@ type TagReference struct { // are ImageStreamTag, ImageStreamImage, and DockerImage. ImageStreamTag references // can only reference a tag within this same ImageStream. From *corev1.ObjectReference `json:"from,omitempty" protobuf:"bytes,3,opt,name=from"` - // Reference states if the tag will be imported. Default value is false, which means the tag will + // reference states if the tag will be imported. Default value is false, which means the tag will // be imported. Reference bool `json:"reference,omitempty" protobuf:"varint,4,opt,name=reference"` - // Generation is a counter that tracks mutations to the spec tag (user intent). When a tag reference + // 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 @@ -293,19 +293,19 @@ type TagReference struct { // nil which will be merged with the current tag generation. // +optional Generation *int64 `json:"generation" protobuf:"varint,5,opt,name=generation"` - // ImportPolicy is information that controls how images may be imported by the server. + // importPolicy is information that controls how images may be imported by the server. ImportPolicy TagImportPolicy `json:"importPolicy,omitempty" protobuf:"bytes,6,opt,name=importPolicy"` - // ReferencePolicy defines how other components should consume the image. + // referencePolicy defines how other components should consume the image. ReferencePolicy TagReferencePolicy `json:"referencePolicy,omitempty" protobuf:"bytes,7,opt,name=referencePolicy"` } // TagImportPolicy controls how images related to this tag will be imported. type TagImportPolicy struct { - // Insecure is true if the server may bypass certificate verification or connect directly over HTTP during image import. + // insecure is true if the server may bypass certificate verification or connect directly over HTTP during image import. Insecure bool `json:"insecure,omitempty" protobuf:"varint,1,opt,name=insecure"` - // Scheduled indicates to the server that this tag should be periodically checked to ensure it is up to date, and imported + // scheduled indicates to the server that this tag should be periodically checked to ensure it is up to date, and imported Scheduled bool `json:"scheduled,omitempty" protobuf:"varint,2,opt,name=scheduled"` - // ImportMode describes how to import an image manifest. + // importMode describes how to import an image manifest. ImportMode ImportModeType `json:"importMode,omitempty" protobuf:"bytes,3,opt,name=importMode,casttype=ImportModeType"` } @@ -342,7 +342,7 @@ const ( // image change triggers in deployment configs or builds are resolved. This allows the image stream // author to control how images are accessed. type TagReferencePolicy struct { - // Type determines how the image pull spec should be transformed when the image stream tag is used in + // 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 @@ -355,14 +355,14 @@ type TagReferencePolicy struct { // ImageStreamStatus contains information about the state of this image stream. type ImageStreamStatus struct { - // DockerImageRepository represents the effective location this stream may be accessed at. + // dockerImageRepository represents the effective location this stream may be accessed at. // May be empty until the server determines where the repository is located DockerImageRepository string `json:"dockerImageRepository" protobuf:"bytes,1,opt,name=dockerImageRepository"` - // PublicDockerImageRepository represents the public location from where the image can + // 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. PublicDockerImageRepository string `json:"publicDockerImageRepository,omitempty" protobuf:"bytes,3,opt,name=publicDockerImageRepository"` - // Tags are a historical record of images associated with each tag. The first entry in the + // tags are a historical record of images associated with each tag. The first entry in the // TagEvent array is the currently tagged image. // +patchMergeKey=tag // +patchStrategy=merge @@ -371,23 +371,23 @@ type ImageStreamStatus struct { // NamedTagEventList relates a tag to its image history. type NamedTagEventList struct { - // Tag is the tag for which the history is recorded + // tag is the tag for which the history is recorded Tag string `json:"tag" protobuf:"bytes,1,opt,name=tag"` // Standard object's metadata. Items []TagEvent `json:"items" protobuf:"bytes,2,rep,name=items"` - // Conditions is an array of conditions that apply to the tag event list. + // conditions is an array of conditions that apply to the tag event list. Conditions []TagEventCondition `json:"conditions,omitempty" protobuf:"bytes,3,rep,name=conditions"` } // TagEvent is used by ImageStreamStatus to keep a historical record of images associated with a tag. type TagEvent struct { - // Created holds the time the TagEvent was created + // created holds the time the TagEvent was created Created metav1.Time `json:"created" protobuf:"bytes,1,opt,name=created"` - // DockerImageReference is the string that can be used to pull this image + // dockerImageReference is the string that can be used to pull this image DockerImageReference string `json:"dockerImageReference" protobuf:"bytes,2,opt,name=dockerImageReference"` - // Image is the image + // image is the image Image string `json:"image" protobuf:"bytes,3,opt,name=image"` - // Generation is the spec tag generation that resulted in this tag being updated + // generation is the spec tag generation that resulted in this tag being updated Generation int64 `json:"generation" protobuf:"varint,4,opt,name=generation"` } @@ -401,17 +401,17 @@ const ( // TagEventCondition contains condition information for a tag event. type TagEventCondition struct { - // Type of tag event condition, currently only ImportSuccess + // type of tag event condition, currently only ImportSuccess Type TagEventConditionType `json:"type" protobuf:"bytes,1,opt,name=type,casttype=TagEventConditionType"` - // Status of the condition, one of True, False, Unknown. + // status of the condition, one of True, False, Unknown. Status corev1.ConditionStatus `json:"status" protobuf:"bytes,2,opt,name=status,casttype=k8s.io/api/core/v1.ConditionStatus"` - // LastTransitionTIme is the time the condition transitioned from one status to another. + // lastTransitionTime is the time the condition transitioned from one status to another. LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty" protobuf:"bytes,3,opt,name=lastTransitionTime"` - // Reason is a brief machine readable explanation for the condition's last transition. + // reason is a brief machine readable explanation for the condition's last transition. Reason string `json:"reason,omitempty" protobuf:"bytes,4,opt,name=reason"` - // Message is a human readable description of the details about last transition, complementing reason. + // message is a human readable description of the details about last transition, complementing reason. Message string `json:"message,omitempty" protobuf:"bytes,5,opt,name=message"` - // Generation is the spec tag generation that this status corresponds to + // generation is the spec tag generation that this status corresponds to Generation int64 `json:"generation" protobuf:"varint,6,opt,name=generation"` } @@ -438,9 +438,9 @@ type ImageStreamMapping struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` - // Image is a container image. + // image is a container image. Image Image `json:"image" protobuf:"bytes,2,opt,name=image"` - // Tag is a string value this image can be located with inside the stream. + // tag is a string value this image can be located with inside the stream. Tag string `json:"tag" protobuf:"bytes,3,opt,name=tag"` } @@ -500,7 +500,7 @@ type ImageStreamTagList struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` - // Items is the list of image stream tags + // items is the list of image stream tags Items []ImageStreamTag `json:"items" protobuf:"bytes,2,rep,name=items"` } @@ -555,7 +555,7 @@ type ImageTagList struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` - // Items is the list of image stream tags + // items is the list of image stream tags Items []ImageTag `json:"items" protobuf:"bytes,2,rep,name=items"` } @@ -585,7 +585,7 @@ type ImageStreamImage struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` - // Image associated with the ImageStream and image name. + // image associated with the ImageStream and image name. Image Image `json:"image" protobuf:"bytes,2,opt,name=image"` } @@ -651,10 +651,10 @@ type ImageBlobReferences struct { // ImageLayerData contains metadata about an image layer. type ImageLayerData struct { - // Size of the layer in bytes as defined by the underlying store. This field is + // 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. LayerSize *int64 `json:"size" protobuf:"varint,1,opt,name=size"` - // MediaType of the referenced object. + // mediaType of the referenced object. MediaType string `json:"mediaType" protobuf:"bytes,2,opt,name=mediaType"` } @@ -680,82 +680,82 @@ type ImageStreamImport struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` - // Spec is a description of the images that the user wishes to import + // spec is a description of the images that the user wishes to import Spec ImageStreamImportSpec `json:"spec" protobuf:"bytes,2,opt,name=spec"` - // Status is the result of importing the image + // status is the result of importing the image Status ImageStreamImportStatus `json:"status" protobuf:"bytes,3,opt,name=status"` } // ImageStreamImportSpec defines what images should be imported. type ImageStreamImportSpec struct { - // Import indicates whether to perform an import - if so, the specified tags are set on the spec + // 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. Import bool `json:"import" protobuf:"varint,1,opt,name=import"` - // Repository is an optional import of an entire container image repository. A maximum limit on the + // 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. Repository *RepositoryImportSpec `json:"repository,omitempty" protobuf:"bytes,2,opt,name=repository"` - // Images are a list of individual images to import. + // images are a list of individual images to import. Images []ImageImportSpec `json:"images,omitempty" protobuf:"bytes,3,rep,name=images"` } // ImageStreamImportStatus contains information about the status of an image stream import. type ImageStreamImportStatus struct { - // Import is the image stream that was successfully updated or created when 'to' was set. + // import is the image stream that was successfully updated or created when 'to' was set. Import *ImageStream `json:"import,omitempty" protobuf:"bytes,1,opt,name=import"` - // Repository is set if spec.repository was set to the outcome of the import + // repository is set if spec.repository was set to the outcome of the import Repository *RepositoryImportStatus `json:"repository,omitempty" protobuf:"bytes,2,opt,name=repository"` - // Images is set with the result of importing spec.images + // images is set with the result of importing spec.images Images []ImageImportStatus `json:"images,omitempty" protobuf:"bytes,3,rep,name=images"` } // RepositoryImportSpec describes a request to import images from a container image repository. type RepositoryImportSpec struct { - // From is the source for the image repository to import; only kind DockerImage and a name of a container image repository is allowed + // from is the source for the image repository to import; only kind DockerImage and a name of a container image repository is allowed From corev1.ObjectReference `json:"from" protobuf:"bytes,1,opt,name=from"` - // ImportPolicy is the policy controlling how the image is imported + // importPolicy is the policy controlling how the image is imported ImportPolicy TagImportPolicy `json:"importPolicy,omitempty" protobuf:"bytes,2,opt,name=importPolicy"` - // ReferencePolicy defines how other components should consume the image + // referencePolicy defines how other components should consume the image ReferencePolicy TagReferencePolicy `json:"referencePolicy,omitempty" protobuf:"bytes,4,opt,name=referencePolicy"` - // IncludeManifest determines if the manifest for each image is returned in the response + // includeManifest determines if the manifest for each image is returned in the response IncludeManifest bool `json:"includeManifest,omitempty" protobuf:"varint,3,opt,name=includeManifest"` } // RepositoryImportStatus describes the result of an image repository import type RepositoryImportStatus struct { - // Status reflects whether any failure occurred during import + // status reflects whether any failure occurred during import Status metav1.Status `json:"status,omitempty" protobuf:"bytes,1,opt,name=status"` - // Images is a list of images successfully retrieved by the import of the repository. + // images is a list of images successfully retrieved by the import of the repository. Images []ImageImportStatus `json:"images,omitempty" protobuf:"bytes,2,rep,name=images"` - // AdditionalTags are tags that exist in the repository but were not imported because + // additionalTags are tags that exist in the repository but were not imported because // a maximum limit of automatic imports was applied. AdditionalTags []string `json:"additionalTags,omitempty" protobuf:"bytes,3,rep,name=additionalTags"` } // ImageImportSpec describes a request to import a specific image. type ImageImportSpec struct { - // From is the source of an image to import; only kind DockerImage is allowed + // from is the source of an image to import; only kind DockerImage is allowed From corev1.ObjectReference `json:"from" protobuf:"bytes,1,opt,name=from"` - // 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 + // 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 To *corev1.LocalObjectReference `json:"to,omitempty" protobuf:"bytes,2,opt,name=to"` - // ImportPolicy is the policy controlling how the image is imported + // importPolicy is the policy controlling how the image is imported ImportPolicy TagImportPolicy `json:"importPolicy,omitempty" protobuf:"bytes,3,opt,name=importPolicy"` - // ReferencePolicy defines how other components should consume the image + // referencePolicy defines how other components should consume the image ReferencePolicy TagReferencePolicy `json:"referencePolicy,omitempty" protobuf:"bytes,5,opt,name=referencePolicy"` - // IncludeManifest determines if the manifest for each image is returned in the response + // includeManifest determines if the manifest for each image is returned in the response IncludeManifest bool `json:"includeManifest,omitempty" protobuf:"varint,4,opt,name=includeManifest"` } // ImageImportStatus describes the result of an image import. type ImageImportStatus struct { - // Status is the status of the image import, including errors encountered while retrieving the image + // status is the status of the image import, including errors encountered while retrieving the image Status metav1.Status `json:"status" protobuf:"bytes,1,opt,name=status"` - // Image is the metadata of that image, if the image was located + // image is the metadata of that image, if the image was located Image *Image `json:"image,omitempty" protobuf:"bytes,2,opt,name=image"` - // Tag is the tag this image was located under, if any + // tag is the tag this image was located under, if any Tag string `json:"tag,omitempty" protobuf:"bytes,3,opt,name=tag"` - // Manifests holds sub-manifests metadata when importing a manifest list + // manifests holds sub-manifests metadata when importing a manifest list Manifests []Image `json:"manifests,omitempty" protobuf:"bytes,4,rep,name=manifests"` } diff --git a/image/v1/zz_generated.swagger_doc_generated.go b/image/v1/zz_generated.swagger_doc_generated.go index ec7fc2b4576..e0720bec772 100644 --- a/image/v1/zz_generated.swagger_doc_generated.go +++ b/image/v1/zz_generated.swagger_doc_generated.go @@ -27,16 +27,16 @@ func (DockerImageReference) SwaggerDoc() map[string]string { var map_Image = map[string]string{ "": "Image is an immutable representation of a container image and 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).", "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "dockerImageReference": "DockerImageReference is the string that can be used to pull this image.", - "dockerImageMetadata": "DockerImageMetadata contains metadata about this image", - "dockerImageMetadataVersion": "DockerImageMetadataVersion conveys the version of the object, which if empty defaults to \"1.0\"", - "dockerImageManifest": "DockerImageManifest is the raw JSON of the manifest", - "dockerImageLayers": "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.", - "signatures": "Signatures holds all signatures of the image.", - "dockerImageSignatures": "DockerImageSignatures provides the signatures as opaque blobs. This is a part of manifest schema v1.", - "dockerImageManifestMediaType": "DockerImageManifestMediaType specifies the mediaType of manifest. This is a part of manifest schema v2.", - "dockerImageConfig": "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.", - "dockerImageManifests": "DockerImageManifests holds information about sub-manifests when the image represents a manifest list. When this field is present, no DockerImageLayers should be specified.", + "dockerImageReference": "dockerImageReference is the string that can be used to pull this image.", + "dockerImageMetadata": "dockerImageMetadata contains metadata about this image", + "dockerImageMetadataVersion": "dockerImageMetadataVersion conveys the version of the object, which if empty defaults to \"1.0\"", + "dockerImageManifest": "dockerImageManifest is the raw JSON of the manifest", + "dockerImageLayers": "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.", + "signatures": "signatures holds all signatures of the image.", + "dockerImageSignatures": "dockerImageSignatures provides the signatures as opaque blobs. This is a part of manifest schema v1.", + "dockerImageManifestMediaType": "dockerImageManifestMediaType specifies the mediaType of manifest. This is a part of manifest schema v2.", + "dockerImageConfig": "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.", + "dockerImageManifests": "dockerImageManifests holds information about sub-manifests when the image represents a manifest list. When this field is present, no DockerImageLayers should be specified.", } func (Image) SwaggerDoc() map[string]string { @@ -57,11 +57,11 @@ func (ImageBlobReferences) SwaggerDoc() map[string]string { var map_ImageImportSpec = map[string]string{ "": "ImageImportSpec describes a request to import a specific image.", - "from": "From is the source of an image to import; only kind DockerImage is allowed", - "to": "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", - "importPolicy": "ImportPolicy is the policy controlling how the image is imported", - "referencePolicy": "ReferencePolicy defines how other components should consume the image", - "includeManifest": "IncludeManifest determines if the manifest for each image is returned in the response", + "from": "from is the source of an image to import; only kind DockerImage is allowed", + "to": "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", + "importPolicy": "importPolicy is the policy controlling how the image is imported", + "referencePolicy": "referencePolicy defines how other components should consume the image", + "includeManifest": "includeManifest determines if the manifest for each image is returned in the response", } func (ImageImportSpec) SwaggerDoc() map[string]string { @@ -70,10 +70,10 @@ func (ImageImportSpec) SwaggerDoc() map[string]string { var map_ImageImportStatus = map[string]string{ "": "ImageImportStatus describes the result of an image import.", - "status": "Status is the status of the image import, including errors encountered while retrieving the image", - "image": "Image is the metadata of that image, if the image was located", - "tag": "Tag is the tag this image was located under, if any", - "manifests": "Manifests holds sub-manifests metadata when importing a manifest list", + "status": "status is the status of the image import, including errors encountered while retrieving the image", + "image": "image is the metadata of that image, if the image was located", + "tag": "tag is the tag this image was located under, if any", + "manifests": "manifests holds sub-manifests metadata when importing a manifest list", } func (ImageImportStatus) SwaggerDoc() map[string]string { @@ -82,9 +82,9 @@ func (ImageImportStatus) SwaggerDoc() map[string]string { var map_ImageLayer = map[string]string{ "": "ImageLayer represents a single layer of the image. Some images may have multiple layers. Some may have none.", - "name": "Name of the layer as defined by the underlying store.", - "size": "Size of the layer in bytes as defined by the underlying store.", - "mediaType": "MediaType of the referenced object.", + "name": "name of the layer as defined by the underlying store.", + "size": "size of the layer in bytes as defined by the underlying store.", + "mediaType": "mediaType of the referenced object.", } func (ImageLayer) SwaggerDoc() map[string]string { @@ -93,8 +93,8 @@ func (ImageLayer) SwaggerDoc() map[string]string { var map_ImageLayerData = map[string]string{ "": "ImageLayerData contains metadata about an image layer.", - "size": "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.", - "mediaType": "MediaType of the referenced object.", + "size": "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.", + "mediaType": "mediaType of the referenced object.", } func (ImageLayerData) SwaggerDoc() map[string]string { @@ -104,7 +104,7 @@ func (ImageLayerData) SwaggerDoc() map[string]string { var map_ImageList = map[string]string{ "": "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).", "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "items": "Items is a list of images", + "items": "items is a list of images", } func (ImageList) SwaggerDoc() map[string]string { @@ -122,12 +122,12 @@ func (ImageLookupPolicy) SwaggerDoc() map[string]string { var map_ImageManifest = map[string]string{ "": "ImageManifest represents sub-manifests of a manifest list. The Digest field points to a regular Image object.", - "digest": "Digest is the unique identifier for the manifest. It refers to an Image object.", - "mediaType": "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.", - "manifestSize": "ManifestSize represents the size of the raw object contents, in bytes.", - "architecture": "Architecture specifies the supported CPU architecture, for example `amd64` or `ppc64le`.", - "os": "OS specifies the operating system, for example `linux`.", - "variant": "Variant is an optional field repreenting a variant of the CPU, for example v6 to specify a particular CPU variant of the ARM CPU.", + "digest": "digest is the unique identifier for the manifest. It refers to an Image object.", + "mediaType": "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.", + "manifestSize": "manifestSize represents the size of the raw object contents, in bytes.", + "architecture": "architecture specifies the supported CPU architecture, for example `amd64` or `ppc64le`.", + "os": "os specifies the operating system, for example `linux`.", + "variant": "variant is an optional field repreenting a variant of the CPU, for example v6 to specify a particular CPU variant of the ARM CPU.", } func (ImageManifest) SwaggerDoc() map[string]string { @@ -139,7 +139,7 @@ var map_ImageSignature = map[string]string{ "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", "type": "Required: Describes a type of stored blob.", "content": "Required: An opaque binary string which is an image's signature.", - "conditions": "Conditions represent the latest available observations of a signature's current state.", + "conditions": "conditions represent the latest available observations of a signature's current state.", "imageIdentity": "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\").", "signedClaims": "Contains claims from the signature.", "created": "If specified, it is the time of signature's creation.", @@ -154,8 +154,8 @@ func (ImageSignature) SwaggerDoc() map[string]string { var map_ImageStream = map[string]string{ "": "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).", "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "spec": "Spec describes the desired state of this stream", - "status": "Status describes the current state of this stream", + "spec": "spec describes the desired state of this stream", + "status": "status describes the current state of this stream", } func (ImageStream) SwaggerDoc() map[string]string { @@ -165,7 +165,7 @@ func (ImageStream) SwaggerDoc() map[string]string { var map_ImageStreamImage = map[string]string{ "": "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).", "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "image": "Image associated with the ImageStream and image name.", + "image": "image associated with the ImageStream and image name.", } func (ImageStreamImage) SwaggerDoc() map[string]string { @@ -175,8 +175,8 @@ func (ImageStreamImage) SwaggerDoc() map[string]string { var map_ImageStreamImport = map[string]string{ "": "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).", "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "spec": "Spec is a description of the images that the user wishes to import", - "status": "Status is the result of importing the image", + "spec": "spec is a description of the images that the user wishes to import", + "status": "status is the result of importing the image", } func (ImageStreamImport) SwaggerDoc() map[string]string { @@ -185,9 +185,9 @@ func (ImageStreamImport) SwaggerDoc() map[string]string { var map_ImageStreamImportSpec = map[string]string{ "": "ImageStreamImportSpec defines what images should be imported.", - "import": "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.", - "repository": "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.", - "images": "Images are a list of individual images to import.", + "import": "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.", + "repository": "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.", + "images": "images are a list of individual images to import.", } func (ImageStreamImportSpec) SwaggerDoc() map[string]string { @@ -196,9 +196,9 @@ func (ImageStreamImportSpec) SwaggerDoc() map[string]string { var map_ImageStreamImportStatus = map[string]string{ "": "ImageStreamImportStatus contains information about the status of an image stream import.", - "import": "Import is the image stream that was successfully updated or created when 'to' was set.", - "repository": "Repository is set if spec.repository was set to the outcome of the import", - "images": "Images is set with the result of importing spec.images", + "import": "import is the image stream that was successfully updated or created when 'to' was set.", + "repository": "repository is set if spec.repository was set to the outcome of the import", + "images": "images is set with the result of importing spec.images", } func (ImageStreamImportStatus) SwaggerDoc() map[string]string { @@ -219,7 +219,7 @@ func (ImageStreamLayers) SwaggerDoc() map[string]string { var map_ImageStreamList = map[string]string{ "": "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).", "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "items": "Items is a list of imageStreams", + "items": "items is a list of imageStreams", } func (ImageStreamList) SwaggerDoc() map[string]string { @@ -229,8 +229,8 @@ func (ImageStreamList) SwaggerDoc() map[string]string { var map_ImageStreamMapping = map[string]string{ "": "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).", "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "image": "Image is a container image.", - "tag": "Tag is a string value this image can be located with inside the stream.", + "image": "image is a container image.", + "tag": "tag is a string value this image can be located with inside the stream.", } func (ImageStreamMapping) SwaggerDoc() map[string]string { @@ -250,9 +250,9 @@ func (ImageStreamSpec) SwaggerDoc() map[string]string { var map_ImageStreamStatus = map[string]string{ "": "ImageStreamStatus contains information about the state of this image stream.", - "dockerImageRepository": "DockerImageRepository represents the effective location this stream may be accessed at. May be empty until the server determines where the repository is located", - "publicDockerImageRepository": "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.", - "tags": "Tags are a historical record of images associated with each tag. The first entry in the TagEvent array is the currently tagged image.", + "dockerImageRepository": "dockerImageRepository represents the effective location this stream may be accessed at. May be empty until the server determines where the repository is located", + "publicDockerImageRepository": "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.", + "tags": "tags are a historical record of images associated with each tag. The first entry in the TagEvent array is the currently tagged image.", } func (ImageStreamStatus) SwaggerDoc() map[string]string { @@ -276,7 +276,7 @@ func (ImageStreamTag) SwaggerDoc() map[string]string { var map_ImageStreamTagList = map[string]string{ "": "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).", "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "items": "Items is the list of image stream tags", + "items": "items is the list of image stream tags", } func (ImageStreamTagList) SwaggerDoc() map[string]string { @@ -298,7 +298,7 @@ func (ImageTag) SwaggerDoc() map[string]string { var map_ImageTagList = map[string]string{ "": "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).", "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "items": "Items is the list of image stream tags", + "items": "items is the list of image stream tags", } func (ImageTagList) SwaggerDoc() map[string]string { @@ -307,9 +307,9 @@ func (ImageTagList) SwaggerDoc() map[string]string { var map_NamedTagEventList = map[string]string{ "": "NamedTagEventList relates a tag to its image history.", - "tag": "Tag is the tag for which the history is recorded", + "tag": "tag is the tag for which the history is recorded", "items": "Standard object's metadata.", - "conditions": "Conditions is an array of conditions that apply to the tag event list.", + "conditions": "conditions is an array of conditions that apply to the tag event list.", } func (NamedTagEventList) SwaggerDoc() map[string]string { @@ -318,10 +318,10 @@ func (NamedTagEventList) SwaggerDoc() map[string]string { var map_RepositoryImportSpec = map[string]string{ "": "RepositoryImportSpec describes a request to import images from a container image repository.", - "from": "From is the source for the image repository to import; only kind DockerImage and a name of a container image repository is allowed", - "importPolicy": "ImportPolicy is the policy controlling how the image is imported", - "referencePolicy": "ReferencePolicy defines how other components should consume the image", - "includeManifest": "IncludeManifest determines if the manifest for each image is returned in the response", + "from": "from is the source for the image repository to import; only kind DockerImage and a name of a container image repository is allowed", + "importPolicy": "importPolicy is the policy controlling how the image is imported", + "referencePolicy": "referencePolicy defines how other components should consume the image", + "includeManifest": "includeManifest determines if the manifest for each image is returned in the response", } func (RepositoryImportSpec) SwaggerDoc() map[string]string { @@ -330,9 +330,9 @@ func (RepositoryImportSpec) SwaggerDoc() map[string]string { var map_RepositoryImportStatus = map[string]string{ "": "RepositoryImportStatus describes the result of an image repository import", - "status": "Status reflects whether any failure occurred during import", - "images": "Images is a list of images successfully retrieved by the import of the repository.", - "additionalTags": "AdditionalTags are tags that exist in the repository but were not imported because a maximum limit of automatic imports was applied.", + "status": "status reflects whether any failure occurred during import", + "images": "images is a list of images successfully retrieved by the import of the repository.", + "additionalTags": "additionalTags are tags that exist in the repository but were not imported because a maximum limit of automatic imports was applied.", } func (RepositoryImportStatus) SwaggerDoc() map[string]string { @@ -341,8 +341,8 @@ func (RepositoryImportStatus) SwaggerDoc() map[string]string { var map_SignatureCondition = map[string]string{ "": "SignatureCondition describes an image signature condition of particular kind at particular probe time.", - "type": "Type of signature condition, Complete or Failed.", - "status": "Status of the condition, one of True, False, Unknown.", + "type": "type of signature condition, Complete or Failed.", + "status": "status of the condition, one of True, False, Unknown.", "lastProbeTime": "Last time the condition was checked.", "lastTransitionTime": "Last time the condition transit from one status to another.", "reason": "(brief) reason for the condition's last transition.", @@ -355,7 +355,7 @@ func (SignatureCondition) SwaggerDoc() map[string]string { var map_SignatureGenericEntity = map[string]string{ "": "SignatureGenericEntity holds a generic information about a person or entity who is an issuer or a subject of signing certificate or key.", - "organization": "Organization name.", + "organization": "organization name.", "commonName": "Common name (e.g. openshift-signing-service).", } @@ -382,10 +382,10 @@ func (SignatureSubject) SwaggerDoc() map[string]string { var map_TagEvent = map[string]string{ "": "TagEvent is used by ImageStreamStatus to keep a historical record of images associated with a tag.", - "created": "Created holds the time the TagEvent was created", - "dockerImageReference": "DockerImageReference is the string that can be used to pull this image", - "image": "Image is the image", - "generation": "Generation is the spec tag generation that resulted in this tag being updated", + "created": "created holds the time the TagEvent was created", + "dockerImageReference": "dockerImageReference is the string that can be used to pull this image", + "image": "image is the image", + "generation": "generation is the spec tag generation that resulted in this tag being updated", } func (TagEvent) SwaggerDoc() map[string]string { @@ -394,12 +394,12 @@ func (TagEvent) SwaggerDoc() map[string]string { var map_TagEventCondition = map[string]string{ "": "TagEventCondition contains condition information for a tag event.", - "type": "Type of tag event condition, currently only ImportSuccess", - "status": "Status of the condition, one of True, False, Unknown.", - "lastTransitionTime": "LastTransitionTIme is the time the condition transitioned from one status to another.", - "reason": "Reason is a brief machine readable explanation for the condition's last transition.", - "message": "Message is a human readable description of the details about last transition, complementing reason.", - "generation": "Generation is the spec tag generation that this status corresponds to", + "type": "type of tag event condition, currently only ImportSuccess", + "status": "status of the condition, one of True, False, Unknown.", + "lastTransitionTime": "lastTransitionTime is the time the condition transitioned from one status to another.", + "reason": "reason is a brief machine readable explanation for the condition's last transition.", + "message": "message is a human readable description of the details about last transition, complementing reason.", + "generation": "generation is the spec tag generation that this status corresponds to", } func (TagEventCondition) SwaggerDoc() map[string]string { @@ -408,9 +408,9 @@ func (TagEventCondition) SwaggerDoc() map[string]string { var map_TagImportPolicy = map[string]string{ "": "TagImportPolicy controls how images related to this tag will be imported.", - "insecure": "Insecure is true if the server may bypass certificate verification or connect directly over HTTP during image import.", - "scheduled": "Scheduled indicates to the server that this tag should be periodically checked to ensure it is up to date, and imported", - "importMode": "ImportMode describes how to import an image manifest.", + "insecure": "insecure is true if the server may bypass certificate verification or connect directly over HTTP during image import.", + "scheduled": "scheduled indicates to the server that this tag should be periodically checked to ensure it is up to date, and imported", + "importMode": "importMode describes how to import an image manifest.", } func (TagImportPolicy) SwaggerDoc() map[string]string { @@ -419,13 +419,13 @@ func (TagImportPolicy) SwaggerDoc() map[string]string { var map_TagReference = map[string]string{ "": "TagReference specifies optional annotations for images using this tag and an optional reference to an ImageStreamTag, ImageStreamImage, or DockerImage this tag should track.", - "name": "Name of the tag", + "name": "name of the tag", "annotations": "Optional; if specified, annotations that are applied to images retrieved via ImageStreamTags.", "from": "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.", - "reference": "Reference states if the tag will be imported. Default value is false, which means the tag will be imported.", - "generation": "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.", - "importPolicy": "ImportPolicy is information that controls how images may be imported by the server.", - "referencePolicy": "ReferencePolicy defines how other components should consume the image.", + "reference": "reference states if the tag will be imported. Default value is false, which means the tag will be imported.", + "generation": "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.", + "importPolicy": "importPolicy is information that controls how images may be imported by the server.", + "referencePolicy": "referencePolicy defines how other components should consume the image.", } func (TagReference) SwaggerDoc() map[string]string { @@ -434,7 +434,7 @@ func (TagReference) SwaggerDoc() map[string]string { var map_TagReferencePolicy = map[string]string{ "": "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": "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": "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.", } func (TagReferencePolicy) SwaggerDoc() map[string]string { diff --git a/imageregistry/v1/types.go b/imageregistry/v1/types.go index 9b3cc21a4d8..3dde9d4c3c1 100644 --- a/imageregistry/v1/types.go +++ b/imageregistry/v1/types.go @@ -477,7 +477,7 @@ const ( // EncryptionAlibaba this a union type in kube parlance. Depending on the value for the AlibabaEncryptionMethod, // different pointers may be used type EncryptionAlibaba struct { - // Method defines the different encrytion modes available + // method defines the different encrytion modes available // Empty value means no opinion and the platform chooses the a default, which is subject to change over time. // Currently the default is `AES256`. // +kubebuilder:validation:Enum="KMS";"AES256" @@ -485,14 +485,14 @@ type EncryptionAlibaba struct { // +optional Method AlibabaEncryptionMethod `json:"method"` - // KMS (key management service) is an encryption type that holds the struct for KMS KeyID + // kms (key management service) is an encryption type that holds the struct for KMS KeyID // +optional KMS *KMSEncryptionAlibaba `json:"kms,omitempty"` } type KMSEncryptionAlibaba struct { - // KeyID holds the KMS encryption key ID - // +kubebuilder:validation:Required + // keyID holds the KMS encryption key ID + // +required // +kubebuilder:validation:MinLength=1 KeyID string `json:"keyID"` } @@ -501,7 +501,7 @@ type KMSEncryptionAlibaba struct { // Configures the registry to use Alibaba Cloud Object Storage Service for backend storage. // More about oss, you can look at the [official documentation](https://www.alibabacloud.com/help/product/31815.htm) type ImageRegistryConfigStorageAlibabaOSS struct { - // Bucket is the bucket name in which you want to store the registry's data. + // bucket is the bucket name in which you want to store the registry's data. // About Bucket naming, more details you can look at the [official documentation](https://www.alibabacloud.com/help/doc-detail/257087.htm) // Empty value means no opinion and the platform chooses the a default, which is subject to change over time. // Currently the default will be autogenerated in the form of -image-registry-- @@ -510,20 +510,20 @@ type ImageRegistryConfigStorageAlibabaOSS struct { // +kubebuilder:validation:Pattern=`^[0-9a-z]+(-[0-9a-z]+)*$` // +optional Bucket string `json:"bucket,omitempty"` - // Region is the Alibaba Cloud Region in which your bucket exists. + // region is the Alibaba Cloud Region in which your bucket exists. // For a list of regions, you can look at the [official documentation](https://www.alibabacloud.com/help/doc-detail/31837.html). // Empty value means no opinion and the platform chooses the a default, which is subject to change over time. // Currently the default will be based on the installed Alibaba Cloud Region. // +optional Region string `json:"region,omitempty"` - // EndpointAccessibility specifies whether the registry use the OSS VPC internal endpoint + // endpointAccessibility specifies whether the registry use the OSS VPC internal endpoint // Empty value means no opinion and the platform chooses the a default, which is subject to change over time. // Currently the default is `Internal`. // +kubebuilder:validation:Enum="Internal";"Public";"" // +kubebuilder:default="Internal" // +optional EndpointAccessibility EndpointAccessibility `json:"endpointAccessibility,omitempty"` - // Encryption specifies whether you would like your data encrypted on the server side. + // encryption specifies whether you would like your data encrypted on the server side. // More details, you can look cat the [official documentation](https://www.alibabacloud.com/help/doc-detail/117914.htm) // +optional Encryption *EncryptionAlibaba `json:"encryption,omitempty"` @@ -556,7 +556,7 @@ type ImageRegistryConfigStorage struct { // ibmcos represents configuration that uses IBM Cloud Object Storage. // +optional IBMCOS *ImageRegistryConfigStorageIBMCOS `json:"ibmcos,omitempty"` - // Oss represents configuration that uses Alibaba Cloud Object Storage Service. + // oss represents configuration that uses Alibaba Cloud Object Storage Service. // +optional OSS *ImageRegistryConfigStorageAlibabaOSS `json:"oss,omitempty"` // managementState indicates if the operator manages the underlying diff --git a/imageregistry/v1/zz_generated.crd-manifests/00_configs.crd.yaml b/imageregistry/v1/zz_generated.crd-manifests/00_configs.crd.yaml index bb088b14e90..81aace2cfc3 100644 --- a/imageregistry/v1/zz_generated.crd-manifests/00_configs.crd.yaml +++ b/imageregistry/v1/zz_generated.crd-manifests/00_configs.crd.yaml @@ -1400,12 +1400,12 @@ spec: pattern: ^(Managed|Unmanaged)$ type: string oss: - description: Oss represents configuration that uses Alibaba Cloud + description: oss represents configuration that uses Alibaba Cloud Object Storage Service. properties: bucket: description: |- - Bucket is the bucket name in which you want to store the registry's data. + bucket is the bucket name in which you want to store the registry's data. About Bucket naming, more details you can look at the [official documentation](https://www.alibabacloud.com/help/doc-detail/257087.htm) Empty value means no opinion and the platform chooses the a default, which is subject to change over time. Currently the default will be autogenerated in the form of -image-registry-- @@ -1430,15 +1430,15 @@ spec: required: - kms description: |- - Encryption specifies whether you would like your data encrypted on the server side. + encryption specifies whether you would like your data encrypted on the server side. More details, you can look cat the [official documentation](https://www.alibabacloud.com/help/doc-detail/117914.htm) properties: kms: - description: KMS (key management service) is an encryption + description: kms (key management service) is an encryption type that holds the struct for KMS KeyID properties: keyID: - description: KeyID holds the KMS encryption key ID + description: keyID holds the KMS encryption key ID minLength: 1 type: string required: @@ -1447,7 +1447,7 @@ spec: method: default: AES256 description: |- - Method defines the different encrytion modes available + method defines the different encrytion modes available Empty value means no opinion and the platform chooses the a default, which is subject to change over time. Currently the default is `AES256`. enum: @@ -1458,7 +1458,7 @@ spec: endpointAccessibility: default: Internal description: |- - EndpointAccessibility specifies whether the registry use the OSS VPC internal endpoint + endpointAccessibility specifies whether the registry use the OSS VPC internal endpoint Empty value means no opinion and the platform chooses the a default, which is subject to change over time. Currently the default is `Internal`. enum: @@ -1468,7 +1468,7 @@ spec: type: string region: description: |- - Region is the Alibaba Cloud Region in which your bucket exists. + region is the Alibaba Cloud Region in which your bucket exists. For a list of regions, you can look at the [official documentation](https://www.alibabacloud.com/help/doc-detail/31837.html). Empty value means no opinion and the platform chooses the a default, which is subject to change over time. Currently the default will be based on the installed Alibaba Cloud Region. @@ -2173,12 +2173,12 @@ spec: pattern: ^(Managed|Unmanaged)$ type: string oss: - description: Oss represents configuration that uses Alibaba Cloud + description: oss represents configuration that uses Alibaba Cloud Object Storage Service. properties: bucket: description: |- - Bucket is the bucket name in which you want to store the registry's data. + bucket is the bucket name in which you want to store the registry's data. About Bucket naming, more details you can look at the [official documentation](https://www.alibabacloud.com/help/doc-detail/257087.htm) Empty value means no opinion and the platform chooses the a default, which is subject to change over time. Currently the default will be autogenerated in the form of -image-registry-- @@ -2188,15 +2188,15 @@ spec: type: string encryption: description: |- - Encryption specifies whether you would like your data encrypted on the server side. + encryption specifies whether you would like your data encrypted on the server side. More details, you can look cat the [official documentation](https://www.alibabacloud.com/help/doc-detail/117914.htm) properties: kms: - description: KMS (key management service) is an encryption + description: kms (key management service) is an encryption type that holds the struct for KMS KeyID properties: keyID: - description: KeyID holds the KMS encryption key ID + description: keyID holds the KMS encryption key ID minLength: 1 type: string required: @@ -2205,7 +2205,7 @@ spec: method: default: AES256 description: |- - Method defines the different encrytion modes available + method defines the different encrytion modes available Empty value means no opinion and the platform chooses the a default, which is subject to change over time. Currently the default is `AES256`. enum: @@ -2216,7 +2216,7 @@ spec: endpointAccessibility: default: Internal description: |- - EndpointAccessibility specifies whether the registry use the OSS VPC internal endpoint + endpointAccessibility specifies whether the registry use the OSS VPC internal endpoint Empty value means no opinion and the platform chooses the a default, which is subject to change over time. Currently the default is `Internal`. enum: @@ -2226,7 +2226,7 @@ spec: type: string region: description: |- - Region is the Alibaba Cloud Region in which your bucket exists. + region is the Alibaba Cloud Region in which your bucket exists. For a list of regions, you can look at the [official documentation](https://www.alibabacloud.com/help/doc-detail/31837.html). Empty value means no opinion and the platform chooses the a default, which is subject to change over time. Currently the default will be based on the installed Alibaba Cloud Region. diff --git a/imageregistry/v1/zz_generated.featuregated-crd-manifests/configs.imageregistry.operator.openshift.io/AAA_ungated.yaml b/imageregistry/v1/zz_generated.featuregated-crd-manifests/configs.imageregistry.operator.openshift.io/AAA_ungated.yaml index c0a4cc35132..5991e399479 100644 --- a/imageregistry/v1/zz_generated.featuregated-crd-manifests/configs.imageregistry.operator.openshift.io/AAA_ungated.yaml +++ b/imageregistry/v1/zz_generated.featuregated-crd-manifests/configs.imageregistry.operator.openshift.io/AAA_ungated.yaml @@ -1399,12 +1399,12 @@ spec: pattern: ^(Managed|Unmanaged)$ type: string oss: - description: Oss represents configuration that uses Alibaba Cloud + description: oss represents configuration that uses Alibaba Cloud Object Storage Service. properties: bucket: description: |- - Bucket is the bucket name in which you want to store the registry's data. + bucket is the bucket name in which you want to store the registry's data. About Bucket naming, more details you can look at the [official documentation](https://www.alibabacloud.com/help/doc-detail/257087.htm) Empty value means no opinion and the platform chooses the a default, which is subject to change over time. Currently the default will be autogenerated in the form of -image-registry-- @@ -1414,15 +1414,15 @@ spec: type: string encryption: description: |- - Encryption specifies whether you would like your data encrypted on the server side. + encryption specifies whether you would like your data encrypted on the server side. More details, you can look cat the [official documentation](https://www.alibabacloud.com/help/doc-detail/117914.htm) properties: kms: - description: KMS (key management service) is an encryption + description: kms (key management service) is an encryption type that holds the struct for KMS KeyID properties: keyID: - description: KeyID holds the KMS encryption key ID + description: keyID holds the KMS encryption key ID minLength: 1 type: string required: @@ -1431,7 +1431,7 @@ spec: method: default: AES256 description: |- - Method defines the different encrytion modes available + method defines the different encrytion modes available Empty value means no opinion and the platform chooses the a default, which is subject to change over time. Currently the default is `AES256`. enum: @@ -1442,7 +1442,7 @@ spec: endpointAccessibility: default: Internal description: |- - EndpointAccessibility specifies whether the registry use the OSS VPC internal endpoint + endpointAccessibility specifies whether the registry use the OSS VPC internal endpoint Empty value means no opinion and the platform chooses the a default, which is subject to change over time. Currently the default is `Internal`. enum: @@ -1452,7 +1452,7 @@ spec: type: string region: description: |- - Region is the Alibaba Cloud Region in which your bucket exists. + region is the Alibaba Cloud Region in which your bucket exists. For a list of regions, you can look at the [official documentation](https://www.alibabacloud.com/help/doc-detail/31837.html). Empty value means no opinion and the platform chooses the a default, which is subject to change over time. Currently the default will be based on the installed Alibaba Cloud Region. @@ -2145,12 +2145,12 @@ spec: pattern: ^(Managed|Unmanaged)$ type: string oss: - description: Oss represents configuration that uses Alibaba Cloud + description: oss represents configuration that uses Alibaba Cloud Object Storage Service. properties: bucket: description: |- - Bucket is the bucket name in which you want to store the registry's data. + bucket is the bucket name in which you want to store the registry's data. About Bucket naming, more details you can look at the [official documentation](https://www.alibabacloud.com/help/doc-detail/257087.htm) Empty value means no opinion and the platform chooses the a default, which is subject to change over time. Currently the default will be autogenerated in the form of -image-registry-- @@ -2160,15 +2160,15 @@ spec: type: string encryption: description: |- - Encryption specifies whether you would like your data encrypted on the server side. + encryption specifies whether you would like your data encrypted on the server side. More details, you can look cat the [official documentation](https://www.alibabacloud.com/help/doc-detail/117914.htm) properties: kms: - description: KMS (key management service) is an encryption + description: kms (key management service) is an encryption type that holds the struct for KMS KeyID properties: keyID: - description: KeyID holds the KMS encryption key ID + description: keyID holds the KMS encryption key ID minLength: 1 type: string required: @@ -2177,7 +2177,7 @@ spec: method: default: AES256 description: |- - Method defines the different encrytion modes available + method defines the different encrytion modes available Empty value means no opinion and the platform chooses the a default, which is subject to change over time. Currently the default is `AES256`. enum: @@ -2188,7 +2188,7 @@ spec: endpointAccessibility: default: Internal description: |- - EndpointAccessibility specifies whether the registry use the OSS VPC internal endpoint + endpointAccessibility specifies whether the registry use the OSS VPC internal endpoint Empty value means no opinion and the platform chooses the a default, which is subject to change over time. Currently the default is `Internal`. enum: @@ -2198,7 +2198,7 @@ spec: type: string region: description: |- - Region is the Alibaba Cloud Region in which your bucket exists. + region is the Alibaba Cloud Region in which your bucket exists. For a list of regions, you can look at the [official documentation](https://www.alibabacloud.com/help/doc-detail/31837.html). Empty value means no opinion and the platform chooses the a default, which is subject to change over time. Currently the default will be based on the installed Alibaba Cloud Region. diff --git a/imageregistry/v1/zz_generated.featuregated-crd-manifests/configs.imageregistry.operator.openshift.io/ChunkSizeMiB.yaml b/imageregistry/v1/zz_generated.featuregated-crd-manifests/configs.imageregistry.operator.openshift.io/ChunkSizeMiB.yaml index 16049e9385c..4a02554b87e 100644 --- a/imageregistry/v1/zz_generated.featuregated-crd-manifests/configs.imageregistry.operator.openshift.io/ChunkSizeMiB.yaml +++ b/imageregistry/v1/zz_generated.featuregated-crd-manifests/configs.imageregistry.operator.openshift.io/ChunkSizeMiB.yaml @@ -1399,12 +1399,12 @@ spec: pattern: ^(Managed|Unmanaged)$ type: string oss: - description: Oss represents configuration that uses Alibaba Cloud + description: oss represents configuration that uses Alibaba Cloud Object Storage Service. properties: bucket: description: |- - Bucket is the bucket name in which you want to store the registry's data. + bucket is the bucket name in which you want to store the registry's data. About Bucket naming, more details you can look at the [official documentation](https://www.alibabacloud.com/help/doc-detail/257087.htm) Empty value means no opinion and the platform chooses the a default, which is subject to change over time. Currently the default will be autogenerated in the form of -image-registry-- @@ -1414,15 +1414,15 @@ spec: type: string encryption: description: |- - Encryption specifies whether you would like your data encrypted on the server side. + encryption specifies whether you would like your data encrypted on the server side. More details, you can look cat the [official documentation](https://www.alibabacloud.com/help/doc-detail/117914.htm) properties: kms: - description: KMS (key management service) is an encryption + description: kms (key management service) is an encryption type that holds the struct for KMS KeyID properties: keyID: - description: KeyID holds the KMS encryption key ID + description: keyID holds the KMS encryption key ID minLength: 1 type: string required: @@ -1431,7 +1431,7 @@ spec: method: default: AES256 description: |- - Method defines the different encrytion modes available + method defines the different encrytion modes available Empty value means no opinion and the platform chooses the a default, which is subject to change over time. Currently the default is `AES256`. enum: @@ -1442,7 +1442,7 @@ spec: endpointAccessibility: default: Internal description: |- - EndpointAccessibility specifies whether the registry use the OSS VPC internal endpoint + endpointAccessibility specifies whether the registry use the OSS VPC internal endpoint Empty value means no opinion and the platform chooses the a default, which is subject to change over time. Currently the default is `Internal`. enum: @@ -1452,7 +1452,7 @@ spec: type: string region: description: |- - Region is the Alibaba Cloud Region in which your bucket exists. + region is the Alibaba Cloud Region in which your bucket exists. For a list of regions, you can look at the [official documentation](https://www.alibabacloud.com/help/doc-detail/31837.html). Empty value means no opinion and the platform chooses the a default, which is subject to change over time. Currently the default will be based on the installed Alibaba Cloud Region. @@ -2157,12 +2157,12 @@ spec: pattern: ^(Managed|Unmanaged)$ type: string oss: - description: Oss represents configuration that uses Alibaba Cloud + description: oss represents configuration that uses Alibaba Cloud Object Storage Service. properties: bucket: description: |- - Bucket is the bucket name in which you want to store the registry's data. + bucket is the bucket name in which you want to store the registry's data. About Bucket naming, more details you can look at the [official documentation](https://www.alibabacloud.com/help/doc-detail/257087.htm) Empty value means no opinion and the platform chooses the a default, which is subject to change over time. Currently the default will be autogenerated in the form of -image-registry-- @@ -2172,15 +2172,15 @@ spec: type: string encryption: description: |- - Encryption specifies whether you would like your data encrypted on the server side. + encryption specifies whether you would like your data encrypted on the server side. More details, you can look cat the [official documentation](https://www.alibabacloud.com/help/doc-detail/117914.htm) properties: kms: - description: KMS (key management service) is an encryption + description: kms (key management service) is an encryption type that holds the struct for KMS KeyID properties: keyID: - description: KeyID holds the KMS encryption key ID + description: keyID holds the KMS encryption key ID minLength: 1 type: string required: @@ -2189,7 +2189,7 @@ spec: method: default: AES256 description: |- - Method defines the different encrytion modes available + method defines the different encrytion modes available Empty value means no opinion and the platform chooses the a default, which is subject to change over time. Currently the default is `AES256`. enum: @@ -2200,7 +2200,7 @@ spec: endpointAccessibility: default: Internal description: |- - EndpointAccessibility specifies whether the registry use the OSS VPC internal endpoint + endpointAccessibility specifies whether the registry use the OSS VPC internal endpoint Empty value means no opinion and the platform chooses the a default, which is subject to change over time. Currently the default is `Internal`. enum: @@ -2210,7 +2210,7 @@ spec: type: string region: description: |- - Region is the Alibaba Cloud Region in which your bucket exists. + region is the Alibaba Cloud Region in which your bucket exists. For a list of regions, you can look at the [official documentation](https://www.alibabacloud.com/help/doc-detail/31837.html). Empty value means no opinion and the platform chooses the a default, which is subject to change over time. Currently the default will be based on the installed Alibaba Cloud Region. diff --git a/imageregistry/v1/zz_generated.swagger_doc_generated.go b/imageregistry/v1/zz_generated.swagger_doc_generated.go index ec999f309b7..f8b421ae86d 100644 --- a/imageregistry/v1/zz_generated.swagger_doc_generated.go +++ b/imageregistry/v1/zz_generated.swagger_doc_generated.go @@ -52,8 +52,8 @@ func (ConfigList) SwaggerDoc() map[string]string { var map_EncryptionAlibaba = map[string]string{ "": "EncryptionAlibaba this a union type in kube parlance. Depending on the value for the AlibabaEncryptionMethod, different pointers may be used", - "method": "Method defines the different encrytion modes available Empty value means no opinion and the platform chooses the a default, which is subject to change over time. Currently the default is `AES256`.", - "kms": "KMS (key management service) is an encryption type that holds the struct for KMS KeyID", + "method": "method defines the different encrytion modes available Empty value means no opinion and the platform chooses the a default, which is subject to change over time. Currently the default is `AES256`.", + "kms": "kms (key management service) is an encryption type that holds the struct for KMS KeyID", } func (EncryptionAlibaba) SwaggerDoc() map[string]string { @@ -112,7 +112,7 @@ var map_ImageRegistryConfigStorage = map[string]string{ "pvc": "pvc represents configuration that uses a PersistentVolumeClaim.", "azure": "azure represents configuration that uses Azure Blob Storage.", "ibmcos": "ibmcos represents configuration that uses IBM Cloud Object Storage.", - "oss": "Oss represents configuration that uses Alibaba Cloud Object Storage Service.", + "oss": "oss represents configuration that uses Alibaba Cloud Object Storage Service.", "managementState": "managementState indicates if the operator manages the underlying storage unit. If Managed the operator will remove the storage when this operator gets Removed.", } @@ -122,10 +122,10 @@ func (ImageRegistryConfigStorage) SwaggerDoc() map[string]string { var map_ImageRegistryConfigStorageAlibabaOSS = map[string]string{ "": "ImageRegistryConfigStorageAlibabaOSS holds Alibaba Cloud OSS configuration. Configures the registry to use Alibaba Cloud Object Storage Service for backend storage. More about oss, you can look at the [official documentation](https://www.alibabacloud.com/help/product/31815.htm)", - "bucket": "Bucket is the bucket name in which you want to store the registry's data. About Bucket naming, more details you can look at the [official documentation](https://www.alibabacloud.com/help/doc-detail/257087.htm) Empty value means no opinion and the platform chooses the a default, which is subject to change over time. Currently the default will be autogenerated in the form of -image-registry--", - "region": "Region is the Alibaba Cloud Region in which your bucket exists. For a list of regions, you can look at the [official documentation](https://www.alibabacloud.com/help/doc-detail/31837.html). Empty value means no opinion and the platform chooses the a default, which is subject to change over time. Currently the default will be based on the installed Alibaba Cloud Region.", - "endpointAccessibility": "EndpointAccessibility specifies whether the registry use the OSS VPC internal endpoint Empty value means no opinion and the platform chooses the a default, which is subject to change over time. Currently the default is `Internal`.", - "encryption": "Encryption specifies whether you would like your data encrypted on the server side. More details, you can look cat the [official documentation](https://www.alibabacloud.com/help/doc-detail/117914.htm)", + "bucket": "bucket is the bucket name in which you want to store the registry's data. About Bucket naming, more details you can look at the [official documentation](https://www.alibabacloud.com/help/doc-detail/257087.htm) Empty value means no opinion and the platform chooses the a default, which is subject to change over time. Currently the default will be autogenerated in the form of -image-registry--", + "region": "region is the Alibaba Cloud Region in which your bucket exists. For a list of regions, you can look at the [official documentation](https://www.alibabacloud.com/help/doc-detail/31837.html). Empty value means no opinion and the platform chooses the a default, which is subject to change over time. Currently the default will be based on the installed Alibaba Cloud Region.", + "endpointAccessibility": "endpointAccessibility specifies whether the registry use the OSS VPC internal endpoint Empty value means no opinion and the platform chooses the a default, which is subject to change over time. Currently the default is `Internal`.", + "encryption": "encryption specifies whether you would like your data encrypted on the server side. More details, you can look cat the [official documentation](https://www.alibabacloud.com/help/doc-detail/117914.htm)", } func (ImageRegistryConfigStorageAlibabaOSS) SwaggerDoc() map[string]string { @@ -266,7 +266,7 @@ func (ImageRegistryStatus) SwaggerDoc() map[string]string { } var map_KMSEncryptionAlibaba = map[string]string{ - "keyID": "KeyID holds the KMS encryption key ID", + "keyID": "keyID holds the KMS encryption key ID", } func (KMSEncryptionAlibaba) SwaggerDoc() map[string]string { diff --git a/insights/v1alpha1/types_insights.go b/insights/v1alpha1/types_insights.go index 9bc847bf7ab..272f7b1e4e5 100644 --- a/insights/v1alpha1/types_insights.go +++ b/insights/v1alpha1/types_insights.go @@ -29,7 +29,7 @@ type DataGather struct { metav1.ObjectMeta `json:"metadata,omitempty"` // spec holds user settable values for configuration - // +kubebuilder:validation:Required + // +required Spec DataGatherSpec `json:"spec"` // status holds observed values from the cluster. They may not be overridden. // +optional @@ -84,7 +84,7 @@ type GathererState string // gathererConfig allows to configure specific gatherers type GathererConfig struct { // name is the name of specific gatherer - // +kubebuilder:validation:Required + // +required Name string `json:"name"` // 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. @@ -126,12 +126,10 @@ type DataGatherStatus struct { // +optional Gatherers []GathererStatus `json:"gatherers,omitempty"` // startTime is the time when Insights data gathering started. - // +kubebuilder:validation:Optional // +kubebuilder:validation:XValidation:rule="self == oldSelf",message="startTime is immutable once set" // +optional StartTime metav1.Time `json:"startTime,omitempty"` // finishTime is the time when Insights data gathering finished. - // +kubebuilder:validation:Optional // +kubebuilder:validation:XValidation:rule="self == oldSelf",message="finishTime is immutable once set" // +optional FinishTime metav1.Time `json:"finishTime,omitempty"` @@ -142,7 +140,6 @@ type DataGatherStatus struct { // 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. // +kubebuilder:validation:XValidation:rule="self == oldSelf",message="insightsRequestID is immutable once set" - // +kubebuilder:validation:Optional // +optional InsightsRequestID string `json:"insightsRequestID,omitempty"` // insightsReport provides general Insights analysis results. @@ -160,16 +157,16 @@ type GathererStatus struct { // +patchStrategy=merge // +listType=map // +listMapKey=type - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:MinItems=1 Conditions []metav1.Condition `json:"conditions" patchStrategy:"merge" patchMergeKey:"type"` // name is the name of the gatherer. - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:MaxLength=256 // +kubebuilder:validation:MinLength=5 Name string `json:"name"` // lastGatherDuration represents the time spent gathering. - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:Type=string // +kubebuilder:validation:Pattern="^([1-9][0-9]*(\\.[0-9]+)?(ns|us|µs|ms|s|m|h))+$" LastGatherDuration metav1.Duration `json:"lastGatherDuration"` @@ -197,25 +194,25 @@ type InsightsReport struct { // healthCheck represents an Insights health check attributes. type HealthCheck struct { // description provides basic description of the healtcheck. - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:MaxLength=2048 // +kubebuilder:validation:MinLength=10 Description string `json:"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. - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:Minimum=1 // +kubebuilder:validation:Maximum=4 TotalRisk int32 `json:"totalRisk"` // advisorURI provides the URL link to the Insights Advisor. - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:Pattern=`^https:\/\/\S+` AdvisorURI string `json:"advisorURI"` // 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. - // +kubebuilder:validation:Required + // +required State HealthCheckState `json:"state"` } @@ -238,17 +235,17 @@ type ObjectReference struct { // This value should consist of only lowercase alphanumeric characters, hyphens and periods. // Example: "", "apps", "build.openshift.io", etc. // +kubebuilder:validation:Pattern:="^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$" - // +kubebuilder:validation:Required + // +required Group string `json:"group"` // 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. - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:Pattern:="^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" Resource string `json:"resource"` // name of the referent. - // +kubebuilder:validation:Required + // +required Name string `json:"name"` // namespace of the referent. // +optional diff --git a/kubecontrolplane/v1/types.go b/kubecontrolplane/v1/types.go index 6d29f42e3fc..cd1ba7ec56d 100644 --- a/kubecontrolplane/v1/types.go +++ b/kubecontrolplane/v1/types.go @@ -38,7 +38,7 @@ type KubeAPIServerConfig struct { // DEPRECATED: consolePublicURL has been deprecated and setting it has no effect. ConsolePublicURL string `json:"consolePublicURL"` - // UserAgentMatchingConfig controls how API calls from *voluntarily* identifying clients will be handled. THIS DOES NOT DEFEND AGAINST MALICIOUS CLIENTS! + // userAgentMatchingConfig controls how API calls from *voluntarily* identifying clients will be handled. THIS DOES NOT DEFEND AGAINST MALICIOUS CLIENTS! // TODO I think we should just drop this feature. UserAgentMatchingConfig UserAgentMatchingConfig `json:"userAgentMatchingConfig"` @@ -153,7 +153,7 @@ type UserAgentMatchRule struct { type UserAgentDenyRule struct { UserAgentMatchRule `json:",inline"` - // RejectionMessage is the message shown when rejecting a client. If it is not a set, the default message is used. + // rejectionMessage is the message shown when rejecting a client. If it is not a set, the default message is used. RejectionMessage string `json:"rejectionMessage"` } @@ -231,6 +231,6 @@ type KubeControllerManagerProjectConfig struct { // ServiceServingCert holds configuration for service serving cert signer which creates cert/key pairs for // pods fulfilling a service to serve with. type ServiceServingCert struct { - // CertFile is a file containing a PEM-encoded certificate + // certFile is a file containing a PEM-encoded certificate CertFile string `json:"certFile"` } diff --git a/kubecontrolplane/v1/zz_generated.swagger_doc_generated.go b/kubecontrolplane/v1/zz_generated.swagger_doc_generated.go index 5ecdd058392..7b5bef143cf 100644 --- a/kubecontrolplane/v1/zz_generated.swagger_doc_generated.go +++ b/kubecontrolplane/v1/zz_generated.swagger_doc_generated.go @@ -28,7 +28,7 @@ var map_KubeAPIServerConfig = map[string]string{ "servicesSubnet": "servicesSubnet is the subnet to use for assigning service IPs", "servicesNodePortRange": "servicesNodePortRange is the range to use for assigning service public ports on a host.", "consolePublicURL": "DEPRECATED: consolePublicURL has been deprecated and setting it has no effect.", - "userAgentMatchingConfig": "UserAgentMatchingConfig controls how API calls from *voluntarily* identifying clients will be handled. THIS DOES NOT DEFEND AGAINST MALICIOUS CLIENTS!", + "userAgentMatchingConfig": "userAgentMatchingConfig controls how API calls from *voluntarily* identifying clients will be handled. THIS DOES NOT DEFEND AGAINST MALICIOUS CLIENTS!", "imagePolicyConfig": "imagePolicyConfig feeds the image policy admission plugin", "projectConfig": "projectConfig feeds an admission plugin", "serviceAccountPublicKeyFiles": "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.", @@ -112,7 +112,7 @@ func (RequestHeaderAuthenticationOptions) SwaggerDoc() map[string]string { var map_ServiceServingCert = map[string]string{ "": "ServiceServingCert holds configuration for service serving cert signer which creates cert/key pairs for pods fulfilling a service to serve with.", - "certFile": "CertFile is a file containing a PEM-encoded certificate", + "certFile": "certFile is a file containing a PEM-encoded certificate", } func (ServiceServingCert) SwaggerDoc() map[string]string { @@ -121,7 +121,7 @@ func (ServiceServingCert) SwaggerDoc() map[string]string { var map_UserAgentDenyRule = map[string]string{ "": "UserAgentDenyRule adds a rejection message that can be used to help a user figure out how to get an approved client", - "rejectionMessage": "RejectionMessage is the message shown when rejecting a client. If it is not a set, the default message is used.", + "rejectionMessage": "rejectionMessage is the message shown when rejecting a client. If it is not a set, the default message is used.", } func (UserAgentDenyRule) SwaggerDoc() map[string]string { diff --git a/legacyconfig/v1/types.go b/legacyconfig/v1/types.go index eaf40b6ee46..c0e03c233a1 100644 --- a/legacyconfig/v1/types.go +++ b/legacyconfig/v1/types.go @@ -21,7 +21,7 @@ type ExtendedArguments map[string][]string type NodeConfig struct { metav1.TypeMeta `json:",inline"` - // NodeName is the value used to identify this particular node in the cluster. If possible, this should be your fully qualified hostname. + // 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 NodeName string `json:"nodeName"` @@ -29,40 +29,40 @@ type NodeConfig struct { // If not specified, network parse/lookup on the nodeName is performed and the first non-loopback address is used NodeIP string `json:"nodeIP"` - // ServingInfo describes how to start serving + // servingInfo describes how to start serving ServingInfo ServingInfo `json:"servingInfo"` - // MasterKubeConfig is a filename for the .kubeconfig file that describes how to connect this node to the master + // masterKubeConfig is a filename for the .kubeconfig file that describes how to connect this node to the master MasterKubeConfig string `json:"masterKubeConfig"` - // MasterClientConnectionOverrides provides overrides to the client connection used to connect to the master. + // masterClientConnectionOverrides provides overrides to the client connection used to connect to the master. MasterClientConnectionOverrides *ClientConnectionOverrides `json:"masterClientConnectionOverrides"` - // DNSDomain holds the domain suffix that will be used for the DNS search path inside each container. Defaults to + // dnsDomain holds the domain suffix that will be used for the DNS search path inside each container. Defaults to // 'cluster.local'. DNSDomain string `json:"dnsDomain"` - // DNSIP is the IP address that pods will use to access cluster DNS. Defaults to the service IP of the Kubernetes + // 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. DNSIP string `json:"dnsIP"` - // DNSBindAddress is the ip:port to serve DNS on. If this is not set, the DNS server will not be started. + // 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. DNSBindAddress string `json:"dnsBindAddress"` - // DNSNameservers is a list of ip:port values of recursive nameservers to forward queries to when running + // 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. DNSNameservers []string `json:"dnsNameservers"` - // DNSRecursiveResolvConf is a path to a resolv.conf file that contains settings for an upstream server. + // 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. DNSRecursiveResolvConf string `json:"dnsRecursiveResolvConf"` @@ -70,57 +70,57 @@ type NodeConfig struct { // Deprecated and maintained for backward compatibility, use NetworkConfig.NetworkPluginName instead DeprecatedNetworkPluginName string `json:"networkPluginName,omitempty"` - // NetworkConfig provides network options for the node + // networkConfig provides network options for the node NetworkConfig NodeNetworkConfig `json:"networkConfig"` - // VolumeDirectory is the directory that volumes will be stored under + // volumeDirectory is the directory that volumes will be stored under VolumeDirectory string `json:"volumeDirectory"` - // ImageConfig holds options that describe how to build image names for system components + // imageConfig holds options that describe how to build image names for system components ImageConfig ImageConfig `json:"imageConfig"` - // 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. + // 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. AllowDisabledDocker bool `json:"allowDisabledDocker"` - // PodManifestConfig holds the configuration for enabling the Kubelet to + // podManifestConfig holds the configuration for enabling the Kubelet to // create pods based from a manifest file(s) placed locally on the node PodManifestConfig *PodManifestConfig `json:"podManifestConfig"` - // AuthConfig holds authn/authz configuration options + // authConfig holds authn/authz configuration options AuthConfig NodeAuthConfig `json:"authConfig"` - // DockerConfig holds Docker related configuration options. + // dockerConfig holds Docker related configuration options. DockerConfig DockerConfig `json:"dockerConfig"` - // KubeletArguments are key value pairs that will be passed directly to the Kubelet that match the Kubelet's + // 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. KubeletArguments ExtendedArguments `json:"kubeletArguments,omitempty"` - // ProxyArguments are key value pairs that will be passed directly to the Proxy that match the Proxy's + // 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. ProxyArguments ExtendedArguments `json:"proxyArguments,omitempty"` - // IPTablesSyncPeriod is how often iptable rules are refreshed + // iptablesSyncPeriod is how often iptable rules are refreshed IPTablesSyncPeriod string `json:"iptablesSyncPeriod"` - // EnableUnidling controls whether or not the hybrid unidling proxy will be set up + // enableUnidling controls whether or not the hybrid unidling proxy will be set up EnableUnidling *bool `json:"enableUnidling"` - // VolumeConfig contains options for configuring volumes on the node. + // volumeConfig contains options for configuring volumes on the node. VolumeConfig NodeVolumeConfig `json:"volumeConfig"` } // NodeVolumeConfig contains options for configuring volumes on the node. type NodeVolumeConfig struct { - // LocalQuota contains options for controlling local volume quota on the node. + // localQuota contains options for controlling local volume quota on the node. LocalQuota LocalQuota `json:"localQuota"` } // MasterVolumeConfig contains options for configuring volume plugins in the master node. type MasterVolumeConfig struct { - // DynamicProvisioningEnabled is a boolean that toggles dynamic provisioning off when false, defaults to true + // dynamicProvisioningEnabled is a boolean that toggles dynamic provisioning off when false, defaults to true DynamicProvisioningEnabled *bool `json:"dynamicProvisioningEnabled"` } @@ -134,24 +134,24 @@ type LocalQuota struct { // NodeAuthConfig holds authn/authz configuration options type NodeAuthConfig struct { - // AuthenticationCacheTTL indicates how long an authentication result should be cached. + // 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 AuthenticationCacheTTL string `json:"authenticationCacheTTL"` - // AuthenticationCacheSize indicates how many authentication results should be cached. If 0, the default cache size is used. + // authenticationCacheSize indicates how many authentication results should be cached. If 0, the default cache size is used. AuthenticationCacheSize int `json:"authenticationCacheSize"` - // AuthorizationCacheTTL indicates how long an authorization result should be cached. + // 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 AuthorizationCacheTTL string `json:"authorizationCacheTTL"` - // AuthorizationCacheSize indicates how many authorization results should be cached. If 0, the default cache size is used. + // authorizationCacheSize indicates how many authorization results should be cached. If 0, the default cache size is used. AuthorizationCacheSize int `json:"authorizationCacheSize"` } // NodeNetworkConfig provides network options for the node type NodeNetworkConfig struct { - // NetworkPluginName is a string specifying the networking plugin + // networkPluginName is a string specifying the networking plugin NetworkPluginName string `json:"networkPluginName"` // Maximum transmission unit for the network packets MTU uint32 `json:"mtu"` @@ -159,14 +159,14 @@ type NodeNetworkConfig struct { // DockerConfig holds Docker related configuration options. type DockerConfig struct { - // ExecHandlerName is the name of the handler to use for executing + // execHandlerName is the name of the handler to use for executing // commands in containers. ExecHandlerName DockerExecHandlerType `json:"execHandlerName"` - // DockerShimSocket is the location of the dockershim socket the kubelet uses. + // 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' DockerShimSocket string `json:"dockerShimSocket"` - // DockershimRootDirectory is the dockershim root directory. + // dockerShimRootDirectory is the dockershim root directory. DockershimRootDirectory string `json:"dockerShimRootDirectory"` } @@ -197,45 +197,45 @@ type FeatureList []string type MasterConfig struct { metav1.TypeMeta `json:",inline"` - // ServingInfo describes how to start serving + // servingInfo describes how to start serving ServingInfo HTTPServingInfo `json:"servingInfo"` - // AuthConfig configures authentication options in addition to the standard + // authConfig configures authentication options in addition to the standard // oauth token and client certificate authenticators AuthConfig MasterAuthConfig `json:"authConfig"` - // AggregatorConfig has options for configuring the aggregator component of the API server. + // aggregatorConfig has options for configuring the aggregator component of the API server. AggregatorConfig AggregatorConfig `json:"aggregatorConfig"` // CORSAllowedOrigins CORSAllowedOrigins []string `json:"corsAllowedOrigins"` - // APILevels is a list of API levels that should be enabled on startup: v1 as examples + // apiLevels is a list of API levels that should be enabled on startup: v1 as examples APILevels []string `json:"apiLevels"` - // MasterPublicURL is how clients can access the OpenShift API server + // masterPublicURL is how clients can access the OpenShift API server MasterPublicURL string `json:"masterPublicURL"` - // Controllers is a list of the controllers that should be started. If set to "none", no controllers + // 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. Controllers string `json:"controllers"` - // AdmissionConfig contains admission control plugin configuration. + // admissionConfig contains admission control plugin configuration. AdmissionConfig AdmissionConfig `json:"admissionConfig"` - // ControllerConfig holds configuration values for controllers + // controllerConfig holds configuration values for controllers ControllerConfig ControllerConfig `json:"controllerConfig"` - // EtcdStorageConfig contains information about how API resources are + // 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. EtcdStorageConfig EtcdStorageConfig `json:"etcdStorageConfig"` - // EtcdClientInfo contains information about how to connect to etcd + // etcdClientInfo contains information about how to connect to etcd EtcdClientInfo EtcdConnectionInfo `json:"etcdClientInfo"` - // KubeletClientInfo contains information about how to connect to kubelets + // kubeletClientInfo contains information about how to connect to kubelets KubeletClientInfo KubeletConnectionInfo `json:"kubeletClientInfo"` // KubernetesMasterConfig, if present start the kubernetes master in this process @@ -248,38 +248,38 @@ type MasterConfig struct { // DNSConfig, if present start the DNS server in this process DNSConfig *DNSConfig `json:"dnsConfig"` - // ServiceAccountConfig holds options related to service accounts + // serviceAccountConfig holds options related to service accounts ServiceAccountConfig ServiceAccountConfig `json:"serviceAccountConfig"` - // MasterClients holds all the client connection information for controllers and other system components + // masterClients holds all the client connection information for controllers and other system components MasterClients MasterClients `json:"masterClients"` - // ImageConfig holds options that describe how to build image names for system components + // imageConfig holds options that describe how to build image names for system components ImageConfig ImageConfig `json:"imageConfig"` - // ImagePolicyConfig controls limits and behavior for importing images + // imagePolicyConfig controls limits and behavior for importing images ImagePolicyConfig ImagePolicyConfig `json:"imagePolicyConfig"` - // PolicyConfig holds information about where to locate critical pieces of bootstrapping policy + // policyConfig holds information about where to locate critical pieces of bootstrapping policy PolicyConfig PolicyConfig `json:"policyConfig"` - // ProjectConfig holds information about project creation and defaults + // projectConfig holds information about project creation and defaults ProjectConfig ProjectConfig `json:"projectConfig"` - // RoutingConfig holds information about routing and route generation + // routingConfig holds information about routing and route generation RoutingConfig RoutingConfig `json:"routingConfig"` - // NetworkConfig to be passed to the compiled in network plugin + // networkConfig to be passed to the compiled in network plugin NetworkConfig MasterNetworkConfig `json:"networkConfig"` // MasterVolumeConfig contains options for configuring volume plugins in the master node. VolumeConfig MasterVolumeConfig `json:"volumeConfig"` - // JenkinsPipelineConfig holds information about the default Jenkins template + // jenkinsPipelineConfig holds information about the default Jenkins template // used for JenkinsPipeline build strategy. JenkinsPipelineConfig JenkinsPipelineConfig `json:"jenkinsPipelineConfig"` - // AuditConfig holds information related to auditing capabilities. + // auditConfig holds information related to auditing capabilities. AuditConfig AuditConfig `json:"auditConfig"` // DisableOpenAPI avoids starting the openapi endpoint because it is very expensive. @@ -290,11 +290,11 @@ type MasterConfig struct { // MasterAuthConfig configures authentication options in addition to the standard // oauth token and client certificate authenticators type MasterAuthConfig struct { - // RequestHeader holds options for setting up a front proxy against the API. It is optional. + // requestHeader holds options for setting up a front proxy against the API. It is optional. RequestHeader *RequestHeaderAuthenticationOptions `json:"requestHeader"` // WebhookTokenAuthnConfig, if present configures remote token reviewers WebhookTokenAuthenticators []WebhookTokenAuthenticator `json:"webhookTokenAuthenticators"` - // OAuthMetadataFile is a path to a file containing the discovery endpoint for OAuth 2.0 Authorization + // 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 @@ -304,22 +304,22 @@ type MasterAuthConfig struct { // RequestHeaderAuthenticationOptions provides options for setting up a front proxy against the entire // API instead of against the /oauth endpoint. type RequestHeaderAuthenticationOptions struct { - // ClientCA is a file with the trusted signer certs. It is required. + // clientCA is a file with the trusted signer certs. It is required. ClientCA string `json:"clientCA"` - // ClientCommonNames is a required list of common names to require a match from. + // clientCommonNames is a required list of common names to require a match from. ClientCommonNames []string `json:"clientCommonNames"` - // UsernameHeaders is the list of headers to check for user information. First hit wins. + // usernameHeaders is the list of headers to check for user information. First hit wins. UsernameHeaders []string `json:"usernameHeaders"` // GroupNameHeader is the set of headers to check for group information. All are unioned. GroupHeaders []string `json:"groupHeaders"` - // ExtraHeaderPrefixes is the set of request header prefixes to inspect for user extra. X-Remote-Extra- is suggested. + // extraHeaderPrefixes is the set of request header prefixes to inspect for user extra. X-Remote-Extra- is suggested. ExtraHeaderPrefixes []string `json:"extraHeaderPrefixes"` } // AggregatorConfig holds information required to make the aggregator function. type AggregatorConfig struct { - // ProxyClientInfo specifies the client cert/key to use when proxying to aggregated API servers + // proxyClientInfo specifies the client cert/key to use when proxying to aggregated API servers ProxyClientInfo CertInfo `json:"proxyClientInfo"` } @@ -357,9 +357,9 @@ type AuditConfig struct { // Maximum size in megabytes of the log file before it gets rotated. Defaults to 100MB. MaximumFileSizeMegabytes int `json:"maximumFileSizeMegabytes"` - // PolicyFile is a path to the file that defines the audit policy configuration. + // policyFile is a path to the file that defines the audit policy configuration. PolicyFile string `json:"policyFile"` - // PolicyConfiguration is an embedded policy configuration object to be used + // 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. PolicyConfiguration runtime.RawExtension `json:"policyConfiguration"` @@ -375,52 +375,52 @@ type AuditConfig struct { // JenkinsPipelineConfig holds configuration for the Jenkins pipeline strategy type JenkinsPipelineConfig struct { - // AutoProvisionEnabled determines whether a Jenkins server will be spawned from the provided + // 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. AutoProvisionEnabled *bool `json:"autoProvisionEnabled"` - // TemplateNamespace contains the namespace name where the Jenkins template is stored + // templateNamespace contains the namespace name where the Jenkins template is stored TemplateNamespace string `json:"templateNamespace"` - // TemplateName is the name of the default Jenkins template + // templateName is the name of the default Jenkins template TemplateName string `json:"templateName"` - // ServiceName is the name of the Jenkins service OpenShift uses to detect + // 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. ServiceName string `json:"serviceName"` - // Parameters specifies a set of optional parameters to the Jenkins template. + // parameters specifies a set of optional parameters to the Jenkins template. Parameters map[string]string `json:"parameters"` } // ImagePolicyConfig holds the necessary configuration options for limits and behavior for importing images type ImagePolicyConfig struct { - // MaxImagesBulkImportedPerRepository controls the number of images that are imported when a user + // 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. MaxImagesBulkImportedPerRepository int `json:"maxImagesBulkImportedPerRepository"` - // DisableScheduledImport allows scheduled background import of images to be disabled. + // disableScheduledImport allows scheduled background import of images to be disabled. DisableScheduledImport bool `json:"disableScheduledImport"` - // ScheduledImageImportMinimumIntervalSeconds is the minimum number of seconds that can elapse between when image streams + // 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. ScheduledImageImportMinimumIntervalSeconds int `json:"scheduledImageImportMinimumIntervalSeconds"` - // MaxScheduledImageImportsPerMinute is the maximum number of scheduled image streams that will be imported in the + // 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. MaxScheduledImageImportsPerMinute int `json:"maxScheduledImageImportsPerMinute"` - // AllowedRegistriesForImport limits the container image registries that normal users may import + // 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. AllowedRegistriesForImport *AllowedRegistries `json:"allowedRegistriesForImport,omitempty"` - // InternalRegistryHostname sets the hostname for the default internal image + // internalRegistryHostname sets the hostname for the default internal image // registry. The value must be in "hostname[:port]" format. InternalRegistryHostname string `json:"internalRegistryHostname,omitempty"` - // ExternalRegistryHostname sets the hostname for the default external image + // 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. ExternalRegistryHostname string `json:"externalRegistryHostname,omitempty"` - // AdditionalTrustedCA is a path to a pem bundle file containing additional CAs that + // additionalTrustedCA is a path to a pem bundle file containing additional CAs that // should be trusted during imagestream import. AdditionalTrustedCA string `json:"additionalTrustedCA,omitempty"` } @@ -431,40 +431,40 @@ type AllowedRegistries []RegistryLocation // RegistryLocation contains a location of the registry specified by the registry domain // name. The domain name might include wildcards, like '*' or '??'. type RegistryLocation struct { - // DomainName specifies a domain name for the registry + // 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. DomainName string `json:"domainName"` - // Insecure indicates whether the registry is secure (https) or insecure (http) + // insecure indicates whether the registry is secure (https) or insecure (http) // By default (if not specified) the registry is assumed as secure. Insecure bool `json:"insecure,omitempty"` } // holds the necessary configuration options for type ProjectConfig struct { - // DefaultNodeSelector holds default project node label selector + // defaultNodeSelector holds default project node label selector DefaultNodeSelector string `json:"defaultNodeSelector"` - // ProjectRequestMessage is the string presented to a user if they are unable to request a project via the projectrequest api endpoint + // projectRequestMessage is the string presented to a user if they are unable to request a project via the projectrequest api endpoint ProjectRequestMessage string `json:"projectRequestMessage"` - // ProjectRequestTemplate is the template to use for creating projects in response to projectrequest. + // 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. ProjectRequestTemplate string `json:"projectRequestTemplate"` - // SecurityAllocator controls the automatic allocation of UIDs and MCS labels to a project. If nil, allocation is disabled. + // securityAllocator controls the automatic allocation of UIDs and MCS labels to a project. If nil, allocation is disabled. SecurityAllocator *SecurityAllocator `json:"securityAllocator"` } // SecurityAllocator controls the automatic allocation of UIDs and MCS labels to a project. If nil, allocation is disabled. type SecurityAllocator struct { - // UIDAllocatorRange defines the total set of Unix user IDs (UIDs) that will be allocated to projects automatically, and the size of the + // 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). UIDAllocatorRange string `json:"uidAllocatorRange"` - // MCSAllocatorRange defines the range of MCS categories that will be assigned to namespaces. The format is + // 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 @@ -475,14 +475,14 @@ type SecurityAllocator struct { // * s0:/2,512 - Allocate labels from s0:c0,c0,c0 to s0:c511,c511,511 // MCSAllocatorRange string `json:"mcsAllocatorRange"` - // MCSLabelsPerProject defines the number of labels that should be reserved per project. The default is 5 to match the default UID and MCS + // 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). MCSLabelsPerProject int `json:"mcsLabelsPerProject"` } // holds the necessary configuration options for type PolicyConfig struct { - // UserAgentMatchingConfig controls how API calls from *voluntarily* identifying clients will be handled. THIS DOES NOT DEFEND AGAINST MALICIOUS CLIENTS! + // userAgentMatchingConfig controls how API calls from *voluntarily* identifying clients will be handled. THIS DOES NOT DEFEND AGAINST MALICIOUS CLIENTS! UserAgentMatchingConfig UserAgentMatchingConfig `json:"userAgentMatchingConfig"` } @@ -494,7 +494,7 @@ type UserAgentMatchingConfig struct { // If this list is non-empty, then a User-Agent must not match any of the UserAgentRegexes DeniedClients []UserAgentDenyRule `json:"deniedClients"` - // DefaultRejectionMessage is the message shown when rejecting a client. If it is not a set, a generic message is given. + // defaultRejectionMessage is the message shown when rejecting a client. If it is not a set, a generic message is given. DefaultRejectionMessage string `json:"defaultRejectionMessage"` } @@ -512,7 +512,7 @@ type UserAgentMatchRule struct { // 8. openshift cli accessing openshift resources: openshift/v1.1.3 (linux/amd64) openshift/b348c2f Regex string `json:"regex"` - // HTTPVerbs specifies which HTTP verbs should be matched. An empty list means "match all verbs". + // httpVerbs specifies which HTTP verbs should be matched. An empty list means "match all verbs". HTTPVerbs []string `json:"httpVerbs"` } @@ -520,13 +520,13 @@ type UserAgentMatchRule struct { type UserAgentDenyRule struct { UserAgentMatchRule `json:",inline"` - // RejectionMessage is the message shown when rejecting a client. If it is not a set, the default message is used. + // rejectionMessage is the message shown when rejecting a client. If it is not a set, the default message is used. RejectionMessage string `json:"rejectionMessage"` } // RoutingConfig holds the necessary configuration options for routing to subdomains type RoutingConfig struct { - // Subdomain is the suffix appended to $service.$namespace. to form the default route hostname + // 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. Subdomain string `json:"subdomain"` @@ -534,51 +534,51 @@ type RoutingConfig struct { // MasterNetworkConfig to be passed to the compiled in network plugin type MasterNetworkConfig struct { - // NetworkPluginName is the name of the network plugin to use + // networkPluginName is the name of the network plugin to use NetworkPluginName string `json:"networkPluginName"` - // ClusterNetworkCIDR is the CIDR string to specify the global overlay network's L3 space. Deprecated, but maintained for backwards compatibility, use ClusterNetworks instead. + // clusterNetworkCIDR is the CIDR string to specify the global overlay network's L3 space. Deprecated, but maintained for backwards compatibility, use ClusterNetworks instead. DeprecatedClusterNetworkCIDR string `json:"clusterNetworkCIDR,omitempty"` - // 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. + // 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. ClusterNetworks []ClusterNetworkEntry `json:"clusterNetworks"` - // 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. + // 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. DeprecatedHostSubnetLength uint32 `json:"hostSubnetLength,omitempty"` // ServiceNetwork is the CIDR string to specify the service networks ServiceNetworkCIDR string `json:"serviceNetworkCIDR"` - // ExternalIPNetworkCIDRs controls what values are acceptable for the service external IP field. If empty, no externalIP + // 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. ExternalIPNetworkCIDRs []string `json:"externalIPNetworkCIDRs"` - // IngressIPNetworkCIDR controls the range to assign ingress ips from for services of type LoadBalancer on bare + // 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. IngressIPNetworkCIDR string `json:"ingressIPNetworkCIDR"` - // VXLANPort is the VXLAN port used by the cluster defaults. If it is not set, 4789 is the default value + // vxlanPort is the VXLAN port used by the cluster defaults. If it is not set, 4789 is the default value VXLANPort uint32 `json:"vxlanPort,omitempty"` } // 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 ClusterNetworkEntry struct { - // CIDR defines the total range of a cluster networks address space. + // cidr defines the total range of a cluster networks address space. CIDR string `json:"cidr"` - // 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. + // 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. HostSubnetLength uint32 `json:"hostSubnetLength"` } // ImageConfig holds the necessary configuration options for building image names for system components type ImageConfig struct { - // Format is the format of the name to be built for the system component + // format is the format of the name to be built for the system component Format string `json:"format"` - // Latest determines if the latest tag will be pulled from the registry + // latest determines if the latest tag will be pulled from the registry Latest bool `json:"latest"` } // RemoteConnectionInfo holds information necessary for establishing a remote connection type RemoteConnectionInfo struct { - // URL is the remote URL to connect to + // url is the remote URL to connect to URL string `json:"url"` - // CA is the CA for verifying TLS connections + // ca is the CA for verifying TLS connections CA string `json:"ca"` // CertInfo is the TLS client cert information to present // this is anonymous so that we can inline it for serialization @@ -587,9 +587,9 @@ type RemoteConnectionInfo struct { // KubeletConnectionInfo holds information necessary for connecting to a kubelet type KubeletConnectionInfo struct { - // Port is the port to connect to kubelets on + // port is the port to connect to kubelets on Port uint `json:"port"` - // CA is the CA for verifying TLS connections to kubelets + // ca is the CA for verifying TLS connections to kubelets CA string `json:"ca"` // CertInfo is the TLS client cert information for securing communication to kubelets // this is anonymous so that we can inline it for serialization @@ -598,9 +598,9 @@ type KubeletConnectionInfo struct { // EtcdConnectionInfo holds information necessary for connecting to an etcd server type EtcdConnectionInfo struct { - // URLs are the URLs for etcd + // urls are the URLs for etcd URLs []string `json:"urls"` - // CA is a file containing trusted roots for the etcd server certificates + // ca is a file containing trusted roots for the etcd server certificates CA string `json:"ca"` // CertInfo is the TLS client cert information for securing communication to etcd // this is anonymous so that we can inline it for serialization @@ -609,19 +609,19 @@ type EtcdConnectionInfo struct { // EtcdStorageConfig holds the necessary configuration options for the etcd storage underlying OpenShift and Kubernetes type EtcdStorageConfig struct { - // KubernetesStorageVersion is the API version that Kube resources in etcd should be + // 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. KubernetesStorageVersion string `json:"kubernetesStorageVersion"` - // KubernetesStoragePrefix is the path within etcd that the Kubernetes resources will + // 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'. KubernetesStoragePrefix string `json:"kubernetesStoragePrefix"` - // OpenShiftStorageVersion is the API version that OS resources in etcd should be + // 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. OpenShiftStorageVersion string `json:"openShiftStorageVersion"` - // OpenShiftStoragePrefix is the path within etcd that the OpenShift resources will + // 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'. OpenShiftStoragePrefix string `json:"openShiftStoragePrefix"` @@ -629,29 +629,29 @@ type EtcdStorageConfig struct { // ServingInfo holds information about serving web pages type ServingInfo struct { - // BindAddress is the ip:port to serve on + // bindAddress is the ip:port to serve on BindAddress string `json:"bindAddress"` - // BindNetwork is the type of network to bind to - defaults to "tcp4", accepts "tcp", + // bindNetwork is the type of network to bind to - defaults to "tcp4", accepts "tcp", // "tcp4", and "tcp6" BindNetwork string `json:"bindNetwork"` // CertInfo is the TLS cert info for serving secure traffic. // this is anonymous so that we can inline it for serialization CertInfo `json:",inline"` - // ClientCA is the certificate bundle for all the signers that you'll recognize for incoming client certificates + // clientCA is the certificate bundle for all the signers that you'll recognize for incoming client certificates ClientCA string `json:"clientCA"` - // NamedCertificates is a list of certificates to use to secure requests to specific hostnames + // namedCertificates is a list of certificates to use to secure requests to specific hostnames NamedCertificates []NamedCertificate `json:"namedCertificates"` - // MinTLSVersion is the minimum TLS version supported. + // minTLSVersion is the minimum TLS version supported. // Values must match version names from https://golang.org/pkg/crypto/tls/#pkg-constants MinTLSVersion string `json:"minTLSVersion,omitempty"` - // CipherSuites contains an overridden list of ciphers for the server to support. + // 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 CipherSuites []string `json:"cipherSuites,omitempty"` } // NamedCertificate specifies a certificate/key, and the names it should be served for type NamedCertificate struct { - // Names is a list of DNS names this certificate should be used to secure + // 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. Names []string `json:"names"` // CertInfo is the TLS cert info for serving secure traffic @@ -662,45 +662,45 @@ type NamedCertificate struct { type HTTPServingInfo struct { // ServingInfo is the HTTP serving information ServingInfo `json:",inline"` - // MaxRequestsInFlight is the number of concurrent requests allowed to the server. If zero, no limit. + // maxRequestsInFlight is the number of concurrent requests allowed to the server. If zero, no limit. MaxRequestsInFlight int `json:"maxRequestsInFlight"` - // RequestTimeoutSeconds is the number of seconds before requests are timed out. The default is 60 minutes, if + // requestTimeoutSeconds is the number of seconds before requests are timed out. The default is 60 minutes, if // -1 there is no limit on requests. RequestTimeoutSeconds int `json:"requestTimeoutSeconds"` } // MasterClients holds references to `.kubeconfig` files that qualify master clients for OpenShift and Kubernetes type MasterClients struct { - // OpenShiftLoopbackKubeConfig is a .kubeconfig filename for system components to loopback to this master + // openshiftLoopbackKubeConfig is a .kubeconfig filename for system components to loopback to this master OpenShiftLoopbackKubeConfig string `json:"openshiftLoopbackKubeConfig"` - // OpenShiftLoopbackClientConnectionOverrides specifies client overrides for system components to loop back to this master. + // openshiftLoopbackClientConnectionOverrides specifies client overrides for system components to loop back to this master. OpenShiftLoopbackClientConnectionOverrides *ClientConnectionOverrides `json:"openshiftLoopbackClientConnectionOverrides"` } // ClientConnectionOverrides are a set of overrides to the default client connection settings. type ClientConnectionOverrides struct { - // AcceptContentTypes defines the Accept header sent by clients when connecting to a server, overriding the + // 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. AcceptContentTypes string `json:"acceptContentTypes"` - // ContentType is the content type used when sending data to the server from this client. + // contentType is the content type used when sending data to the server from this client. ContentType string `json:"contentType"` - // QPS controls the number of queries per second allowed for this connection. + // qps controls the number of queries per second allowed for this connection. QPS float32 `json:"qps"` - // Burst allows extra queries to accumulate when a client is exceeding its rate. + // burst allows extra queries to accumulate when a client is exceeding its rate. Burst int32 `json:"burst"` } // DNSConfig holds the necessary configuration options for DNS type DNSConfig struct { - // BindAddress is the ip:port to serve DNS on + // bindAddress is the ip:port to serve DNS on BindAddress string `json:"bindAddress"` - // BindNetwork is the type of network to bind to - defaults to "tcp4", accepts "tcp", + // bindNetwork is the type of network to bind to - defaults to "tcp4", accepts "tcp", // "tcp4", and "tcp6" BindNetwork string `json:"bindNetwork"` - // AllowRecursiveQueries allows the DNS server on the master to answer queries recursively. Note that open + // 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. AllowRecursiveQueries bool `json:"allowRecursiveQueries"` @@ -709,9 +709,9 @@ type DNSConfig struct { // WebhookTokenAuthenticators holds the necessary configuation options for // external token authenticators type WebhookTokenAuthenticator struct { - // ConfigFile is a path to a Kubeconfig file with the webhook configuration + // configFile is a path to a Kubeconfig file with the webhook configuration ConfigFile string `json:"configFile"` - // CacheTTL indicates how long an authentication result should be cached. + // 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 @@ -720,85 +720,85 @@ type WebhookTokenAuthenticator struct { // OAuthConfig holds the necessary configuration options for OAuth authentication type OAuthConfig struct { - // MasterCA is the CA for verifying the TLS connection back to the MasterURL. + // masterCA is the CA for verifying the TLS connection back to the MasterURL. MasterCA *string `json:"masterCA"` - // MasterURL is used for making server-to-server calls to exchange authorization codes for access tokens + // masterURL is used for making server-to-server calls to exchange authorization codes for access tokens MasterURL string `json:"masterURL"` - // MasterPublicURL is used for building valid client redirect URLs for internal and external access + // masterPublicURL is used for building valid client redirect URLs for internal and external access MasterPublicURL string `json:"masterPublicURL"` - // AssetPublicURL is used for building valid client redirect URLs for external access + // assetPublicURL is used for building valid client redirect URLs for external access AssetPublicURL string `json:"assetPublicURL"` - // AlwaysShowProviderSelection will force the provider selection page to render even when there is only a single provider. + // alwaysShowProviderSelection will force the provider selection page to render even when there is only a single provider. AlwaysShowProviderSelection bool `json:"alwaysShowProviderSelection"` - // IdentityProviders is an ordered list of ways for a user to identify themselves + // identityProviders is an ordered list of ways for a user to identify themselves IdentityProviders []IdentityProvider `json:"identityProviders"` - // GrantConfig describes how to handle grants + // grantConfig describes how to handle grants GrantConfig GrantConfig `json:"grantConfig"` - // SessionConfig hold information about configuring sessions. + // sessionConfig hold information about configuring sessions. SessionConfig *SessionConfig `json:"sessionConfig"` - // TokenConfig contains options for authorization and access tokens + // tokenConfig contains options for authorization and access tokens TokenConfig TokenConfig `json:"tokenConfig"` - // Templates allow you to customize pages like the login page. + // templates allow you to customize pages like the login page. Templates *OAuthTemplates `json:"templates"` } // OAuthTemplates allow for customization of pages like the login page type OAuthTemplates struct { - // Login is a path to a file containing a go template used to render the login page. + // 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. Login string `json:"login"` - // ProviderSelection is a path to a file containing a go template used to render the provider selection page. + // 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. ProviderSelection string `json:"providerSelection"` - // Error is a path to a file containing a go template used to render error pages during the authentication or grant flow + // 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. Error string `json:"error"` } // ServiceAccountConfig holds the necessary configuration options for a service account type ServiceAccountConfig struct { - // ManagedNames is a list of service account names that will be auto-created in every namespace. + // 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. ManagedNames []string `json:"managedNames"` - // LimitSecretReferences controls whether or not to allow a service account to reference any secret in a namespace + // limitSecretReferences controls whether or not to allow a service account to reference any secret in a namespace // without explicitly referencing them LimitSecretReferences bool `json:"limitSecretReferences"` - // PrivateKeyFile is a file containing a PEM-encoded private RSA key, used to sign service account tokens. + // 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. PrivateKeyFile string `json:"privateKeyFile"` - // PublicKeyFiles is a list of files, each containing a PEM-encoded public RSA key. + // 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. PublicKeyFiles []string `json:"publicKeyFiles"` - // MasterCA is the CA for verifying the TLS connection back to the master. The service account controller will automatically + // 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. MasterCA string `json:"masterCA"` } // TokenConfig holds the necessary configuration options for authorization and access tokens type TokenConfig struct { - // AuthorizeTokenMaxAgeSeconds defines the maximum age of authorize tokens + // authorizeTokenMaxAgeSeconds defines the maximum age of authorize tokens AuthorizeTokenMaxAgeSeconds int32 `json:"authorizeTokenMaxAgeSeconds"` - // AccessTokenMaxAgeSeconds defines the maximum age of access tokens + // accessTokenMaxAgeSeconds defines the maximum age of access tokens AccessTokenMaxAgeSeconds int32 `json:"accessTokenMaxAgeSeconds"` - // AccessTokenInactivityTimeoutSeconds defined the default token + // 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 overriden on OAuthClient basis. @@ -815,12 +815,12 @@ type TokenConfig struct { // SessionConfig specifies options for cookie-based sessions. Used by AuthRequestHandlerSession type SessionConfig struct { - // SessionSecretsFile is a reference to a file containing a serialized SessionSecrets object + // 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 SessionSecretsFile string `json:"sessionSecretsFile"` - // SessionMaxAgeSeconds specifies how long created sessions last. Used by AuthRequestHandlerSession + // sessionMaxAgeSeconds specifies how long created sessions last. Used by AuthRequestHandlerSession SessionMaxAgeSeconds int32 `json:"sessionMaxAgeSeconds"` - // SessionName is the cookie name used to store the session + // sessionName is the cookie name used to store the session SessionName string `json:"sessionName"` } @@ -834,7 +834,7 @@ type SessionConfig struct { type SessionSecrets struct { metav1.TypeMeta `json:",inline"` - // Secrets is a list of secrets + // 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. Secrets []SessionSecret `json:"secrets"` @@ -842,23 +842,23 @@ type SessionSecrets struct { // SessionSecret is a secret used to authenticate/decrypt cookie-based sessions type SessionSecret struct { - // Authentication is used to authenticate sessions using HMAC. Recommended to use a secret with 32 or 64 bytes. + // authentication is used to authenticate sessions using HMAC. Recommended to use a secret with 32 or 64 bytes. Authentication string `json:"authentication"` - // Encryption is used to encrypt sessions. Must be 16, 24, or 32 characters long, to select AES-128, AES- + // encryption is used to encrypt sessions. Must be 16, 24, or 32 characters long, to select AES-128, AES- Encryption string `json:"encryption"` } // IdentityProvider provides identities for users authenticating using credentials type IdentityProvider struct { - // Name is used to qualify the identities returned by this provider + // name is used to qualify the identities returned by this provider Name string `json:"name"` // UseAsChallenger indicates whether to issue WWW-Authenticate challenges for this provider UseAsChallenger bool `json:"challenge"` // UseAsLogin indicates whether to use this identity provider for unauthenticated browsers to login against UseAsLogin bool `json:"login"` - // MappingMethod determines how identities from this provider are mapped to users + // mappingMethod determines how identities from this provider are mapped to users MappingMethod string `json:"mappingMethod"` - // Provider contains the information about how to set up a specific identity provider + // provider contains the information about how to set up a specific identity provider Provider runtime.RawExtension `json:"provider"` } @@ -908,7 +908,7 @@ type DenyAllPasswordIdentityProvider struct { type HTPasswdPasswordIdentityProvider struct { metav1.TypeMeta `json:",inline"` - // File is a reference to your htpasswd file + // file is a reference to your htpasswd file File string `json:"file"` } @@ -921,38 +921,38 @@ type HTPasswdPasswordIdentityProvider struct { // +openshift:compatibility-gen:internal type LDAPPasswordIdentityProvider struct { metav1.TypeMeta `json:",inline"` - // URL is an RFC 2255 URL which specifies the LDAP search parameters to use. The syntax of the URL is + // 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 URL string `json:"url"` - // BindDN is an optional DN to bind with during the search phase. + // bindDN is an optional DN to bind with during the search phase. BindDN string `json:"bindDN"` - // BindPassword is an optional password to bind with during the search phase. + // bindPassword is an optional password to bind with during the search phase. BindPassword StringSource `json:"bindPassword"` // 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 Insecure bool `json:"insecure"` - // CA is the optional trusted certificate authority bundle to use when making requests to the server + // ca is the optional trusted certificate authority bundle to use when making requests to the server // If empty, the default system roots are used CA string `json:"ca"` - // Attributes maps LDAP attributes to identities + // attributes maps LDAP attributes to identities Attributes LDAPAttributeMapping `json:"attributes"` } // LDAPAttributeMapping maps LDAP attributes to OpenShift identity fields type LDAPAttributeMapping struct { - // ID is the list of attributes whose values should be used as the user ID. Required. + // id is the list of attributes whose values should be used as the user ID. Required. // LDAP standard identity attribute is "dn" ID []string `json:"id"` - // PreferredUsername is the list of attributes whose values should be used as the preferred username. + // preferredUsername is the list of attributes whose values should be used as the preferred username. // LDAP standard login attribute is "uid" PreferredUsername []string `json:"preferredUsername"` - // Name is the list of attributes whose values should be used as the display name. Optional. + // 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" Name []string `json:"name"` - // Email is the list of attributes whose values should be used as the email address. Optional. + // 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 Email []string `json:"email"` } @@ -970,7 +970,7 @@ type KeystonePasswordIdentityProvider struct { RemoteConnectionInfo `json:",inline"` // Domain Name is required for keystone v3 DomainName string `json:"domainName"` - // UseKeystoneIdentity flag indicates that user should be authenticated by keystone ID, not by username + // useKeystoneIdentity flag indicates that user should be authenticated by keystone ID, not by username UseKeystoneIdentity bool `json:"useKeystoneIdentity"` } @@ -984,7 +984,7 @@ type KeystonePasswordIdentityProvider struct { type RequestHeaderIdentityProvider struct { metav1.TypeMeta `json:",inline"` - // LoginURL is a URL to redirect unauthenticated /authorize requests to + // 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 // https://www.example.com/sso-login?then=${url} @@ -992,7 +992,7 @@ type RequestHeaderIdentityProvider struct { // https://www.example.com/auth-proxy/oauth/authorize?${query} LoginURL string `json:"loginURL"` - // ChallengeURL is a URL to redirect unauthenticated /authorize requests to + // 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 // https://www.example.com/sso-login?then=${url} @@ -1000,18 +1000,18 @@ type RequestHeaderIdentityProvider struct { // https://www.example.com/auth-proxy/oauth/authorize?${query} ChallengeURL string `json:"challengeURL"` - // 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. + // 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. ClientCA string `json:"clientCA"` - // 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. + // 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. ClientCommonNames []string `json:"clientCommonNames"` - // Headers is the set of headers to check for identity information + // headers is the set of headers to check for identity information Headers []string `json:"headers"` - // PreferredUsernameHeaders is the set of headers to check for the preferred username + // preferredUsernameHeaders is the set of headers to check for the preferred username PreferredUsernameHeaders []string `json:"preferredUsernameHeaders"` - // NameHeaders is the set of headers to check for the display name + // nameHeaders is the set of headers to check for the display name NameHeaders []string `json:"nameHeaders"` - // EmailHeaders is the set of headers to check for the email address + // emailHeaders is the set of headers to check for the email address EmailHeaders []string `json:"emailHeaders"` } @@ -1025,18 +1025,18 @@ type RequestHeaderIdentityProvider struct { type GitHubIdentityProvider struct { metav1.TypeMeta `json:",inline"` - // ClientID is the oauth client ID + // clientID is the oauth client ID ClientID string `json:"clientID"` - // ClientSecret is the oauth client secret + // clientSecret is the oauth client secret ClientSecret StringSource `json:"clientSecret"` - // Organizations optionally restricts which organizations are allowed to log in + // organizations optionally restricts which organizations are allowed to log in Organizations []string `json:"organizations"` - // Teams optionally restricts which teams are allowed to log in. Format is /. + // teams optionally restricts which teams are allowed to log in. Format is /. Teams []string `json:"teams"` - // Hostname is the optional domain (e.g. "mycompany.com") for use with a hosted instance of GitHub Enterprise. + // 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. Hostname string `json:"hostname"` - // CA is the optional trusted certificate authority bundle to use when making requests to the server. + // 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. CA string `json:"ca"` } @@ -1051,16 +1051,16 @@ type GitHubIdentityProvider struct { type GitLabIdentityProvider struct { metav1.TypeMeta `json:",inline"` - // CA is the optional trusted certificate authority bundle to use when making requests to the server + // ca is the optional trusted certificate authority bundle to use when making requests to the server // If empty, the default system roots are used CA string `json:"ca"` - // URL is the oauth server base URL + // url is the oauth server base URL URL string `json:"url"` - // ClientID is the oauth client ID + // clientID is the oauth client ID ClientID string `json:"clientID"` - // ClientSecret is the oauth client secret + // clientSecret is the oauth client secret ClientSecret StringSource `json:"clientSecret"` - // Legacy determines if OAuth2 or OIDC should be used + // 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 @@ -1080,12 +1080,12 @@ type GitLabIdentityProvider struct { type GoogleIdentityProvider struct { metav1.TypeMeta `json:",inline"` - // ClientID is the oauth client ID + // clientID is the oauth client ID ClientID string `json:"clientID"` - // ClientSecret is the oauth client secret + // clientSecret is the oauth client secret ClientSecret StringSource `json:"clientSecret"` - // HostedDomain is the optional Google App domain (e.g. "mycompany.com") to restrict logins to + // hostedDomain is the optional Google App domain (e.g. "mycompany.com") to restrict logins to HostedDomain string `json:"hostedDomain"` } @@ -1099,35 +1099,35 @@ type GoogleIdentityProvider struct { type OpenIDIdentityProvider struct { metav1.TypeMeta `json:",inline"` - // CA is the optional trusted certificate authority bundle to use when making requests to the server + // ca is the optional trusted certificate authority bundle to use when making requests to the server // If empty, the default system roots are used CA string `json:"ca"` - // ClientID is the oauth client ID + // clientID is the oauth client ID ClientID string `json:"clientID"` - // ClientSecret is the oauth client secret + // clientSecret is the oauth client secret ClientSecret StringSource `json:"clientSecret"` - // ExtraScopes are any scopes to request in addition to the standard "openid" scope. + // extraScopes are any scopes to request in addition to the standard "openid" scope. ExtraScopes []string `json:"extraScopes"` - // ExtraAuthorizeParameters are any custom parameters to add to the authorize request. + // extraAuthorizeParameters are any custom parameters to add to the authorize request. ExtraAuthorizeParameters map[string]string `json:"extraAuthorizeParameters"` - // URLs to use to authenticate + // urls to use to authenticate URLs OpenIDURLs `json:"urls"` - // Claims mappings + // claims mappings Claims OpenIDClaims `json:"claims"` } // OpenIDURLs are URLs to use when authenticating with an OpenID identity provider type OpenIDURLs struct { - // Authorize is the oauth authorization URL + // authorize is the oauth authorization URL Authorize string `json:"authorize"` - // Token is the oauth token granting URL + // token is the oauth token granting URL Token string `json:"token"` - // UserInfo is the optional userinfo URL. + // 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 UserInfo string `json:"userInfo"` @@ -1135,23 +1135,23 @@ type OpenIDURLs struct { // OpenIDClaims contains a list of OpenID claims to use when authenticating with an OpenID identity provider type OpenIDClaims struct { - // ID is the list of claims whose values should be used as the user ID. Required. + // id is the list of claims whose values should be used as the user ID. Required. // OpenID standard identity claim is "sub" ID []string `json:"id"` - // PreferredUsername is the list of claims whose values should be used as the preferred username. + // 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 PreferredUsername []string `json:"preferredUsername"` - // Name is the list of claims whose values should be used as the display name. Optional. + // 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 Name []string `json:"name"` - // Email is the list of claims whose values should be used as the email address. Optional. + // 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 Email []string `json:"email"` } // GrantConfig holds the necessary configuration options for grant handlers type GrantConfig struct { - // Method determines the default strategy to use when an OAuth client requests a grant. + // 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: // - auto: always approves grant requests, useful for trusted clients @@ -1159,7 +1159,7 @@ type GrantConfig struct { // - deny: always denies grant requests, useful for black-listed clients Method GrantHandlerType `json:"method"` - // ServiceAccountMethod is used for determining client authorization for service account oauth client. + // serviceAccountMethod is used for determining client authorization for service account oauth client. // It must be either: deny, prompt ServiceAccountMethod GrantHandlerType `json:"serviceAccountMethod"` } @@ -1177,13 +1177,13 @@ const ( // EtcdConfig holds the necessary configuration options for connecting with an etcd database type EtcdConfig struct { - // ServingInfo describes how to start serving the etcd master + // servingInfo describes how to start serving the etcd master ServingInfo ServingInfo `json:"servingInfo"` - // Address is the advertised host:port for client connections to etcd + // address is the advertised host:port for client connections to etcd Address string `json:"address"` - // PeerServingInfo describes how to start serving the etcd peer + // peerServingInfo describes how to start serving the etcd peer PeerServingInfo ServingInfo `json:"peerServingInfo"` - // PeerAddress is the advertised host:port for peer connections to etcd + // peerAddress is the advertised host:port for peer connections to etcd PeerAddress string `json:"peerAddress"` // StorageDir is the path to the etcd storage directory @@ -1192,42 +1192,42 @@ type EtcdConfig struct { // KubernetesMasterConfig holds the necessary configuration options for the Kubernetes master type KubernetesMasterConfig struct { - // APILevels is a list of API levels that should be enabled on startup: v1 as examples + // apiLevels is a list of API levels that should be enabled on startup: v1 as examples APILevels []string `json:"apiLevels"` - // DisabledAPIGroupVersions is a map of groups to the versions (or *) that should be disabled. + // disabledAPIGroupVersions is a map of groups to the versions (or *) that should be disabled. DisabledAPIGroupVersions map[string][]string `json:"disabledAPIGroupVersions"` - // MasterIP is the public IP address of kubernetes stuff. If empty, the first result from net.InterfaceAddrs will be used. + // masterIP is the public IP address of kubernetes stuff. If empty, the first result from net.InterfaceAddrs will be used. MasterIP string `json:"masterIP"` - // MasterEndpointReconcileTTL sets the time to live in seconds of an endpoint record recorded by each master. The endpoints are checked + // 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. MasterEndpointReconcileTTL int `json:"masterEndpointReconcileTTL"` - // ServicesSubnet is the subnet to use for assigning service IPs + // servicesSubnet is the subnet to use for assigning service IPs ServicesSubnet string `json:"servicesSubnet"` - // ServicesNodePortRange is the range to use for assigning service public ports on a host. + // servicesNodePortRange is the range to use for assigning service public ports on a host. ServicesNodePortRange string `json:"servicesNodePortRange"` - // SchedulerConfigFile points to a file that describes how to set up the scheduler. If empty, you get the default scheduling rules. + // schedulerConfigFile points to a file that describes how to set up the scheduler. If empty, you get the default scheduling rules. SchedulerConfigFile string `json:"schedulerConfigFile"` - // PodEvictionTimeout controls grace period for deleting pods on failed nodes. + // 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. PodEvictionTimeout string `json:"podEvictionTimeout"` - // ProxyClientInfo specifies the client cert/key to use when proxying to pods + // proxyClientInfo specifies the client cert/key to use when proxying to pods ProxyClientInfo CertInfo `json:"proxyClientInfo"` - // APIServerArguments are key value pairs that will be passed directly to the Kube apiserver that match the apiservers's + // 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. APIServerArguments ExtendedArguments `json:"apiServerArguments"` - // ControllerArguments are key value pairs that will be passed directly to the Kube controller manager that match the + // 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. ControllerArguments ExtendedArguments `json:"controllerArguments"` - // SchedulerArguments are key value pairs that will be passed directly to the Kube scheduler that match the scheduler's + // 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. SchedulerArguments ExtendedArguments `json:"schedulerArguments"` @@ -1235,19 +1235,19 @@ type KubernetesMasterConfig struct { // CertInfo relates a certificate with a private key type CertInfo struct { - // CertFile is a file containing a PEM-encoded certificate + // certFile is a file containing a PEM-encoded certificate CertFile string `json:"certFile"` - // KeyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile + // keyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile KeyFile string `json:"keyFile"` } // PodManifestConfig holds the necessary configuration options for using pod manifests type PodManifestConfig struct { - // Path specifies the path for the pod manifest file or directory + // 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 Path string `json:"path"` - // FileCheckIntervalSeconds is the interval in seconds for checking the manifest file(s) for new data + // fileCheckIntervalSeconds is the interval in seconds for checking the manifest file(s) for new data // The interval needs to be a positive value FileCheckIntervalSeconds int64 `json:"fileCheckIntervalSeconds"` } @@ -1261,16 +1261,16 @@ type StringSource struct { // StringSourceSpec specifies a string value, or external location type StringSourceSpec struct { - // Value specifies the cleartext value, or an encrypted value if keyFile is specified. + // value specifies the cleartext value, or an encrypted value if keyFile is specified. Value string `json:"value"` - // Env specifies an envvar containing the cleartext value, or an encrypted value if the keyFile is specified. + // env specifies an envvar containing the cleartext value, or an encrypted value if the keyFile is specified. Env string `json:"env"` - // File references a file containing the cleartext value, or an encrypted value if a keyFile is specified. + // file references a file containing the cleartext value, or an encrypted value if a keyFile is specified. File string `json:"file"` - // KeyFile references a file containing the key to use to decrypt the value. + // keyFile references a file containing the key to use to decrypt the value. KeyFile string `json:"keyFile"` } @@ -1286,16 +1286,16 @@ type LDAPSyncConfig struct { // Host is the scheme, host and port of the LDAP server to connect to: // scheme://host:port URL string `json:"url"` - // BindDN is an optional DN to bind to the LDAP server with + // bindDN is an optional DN to bind to the LDAP server with BindDN string `json:"bindDN"` - // BindPassword is an optional password to bind with during the search phase. + // bindPassword is an optional password to bind with during the search phase. BindPassword StringSource `json:"bindPassword"` // 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 Insecure bool `json:"insecure"` - // CA is the optional trusted certificate authority bundle to use when making requests to the server + // ca is the optional trusted certificate authority bundle to use when making requests to the server // If empty, the default system roots are used CA string `json:"ca"` @@ -1329,33 +1329,33 @@ type RFC2307Config struct { // (ldapGroupUID) GroupUIDAttribute string `json:"groupUIDAttribute"` - // GroupNameAttributes defines which attributes on an LDAP group entry will be interpreted as its name to use for + // groupNameAttributes defines which attributes on an LDAP group entry will be interpreted as its name to use for // an OpenShift group GroupNameAttributes []string `json:"groupNameAttributes"` - // GroupMembershipAttributes defines which attributes on an LDAP group entry will be interpreted as its members. + // 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 GroupMembershipAttributes []string `json:"groupMembershipAttributes"` // AllUsersQuery holds the template for an LDAP query that returns user entries. AllUsersQuery LDAPQuery `json:"usersQuery"` - // UserUIDAttribute defines which attribute on an LDAP user entry will be interpreted as its unique identifier. + // 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 UserUIDAttribute string `json:"userUIDAttribute"` - // UserNameAttributes defines which attributes on an LDAP user entry will be used, in order, as its OpenShift user name. + // 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 UserNameAttributes []string `json:"userNameAttributes"` - // TolerateMemberNotFoundErrors determines the behavior of the LDAP sync job when missing user entries are + // 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. TolerateMemberNotFoundErrors bool `json:"tolerateMemberNotFoundErrors"` - // TolerateMemberOutOfScopeErrors determines the behavior of the LDAP sync job when out-of-scope user entries + // 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 @@ -1370,10 +1370,10 @@ type ActiveDirectoryConfig struct { // AllUsersQuery holds the template for an LDAP query that returns user entries. AllUsersQuery LDAPQuery `json:"usersQuery"` - // UserNameAttributes defines which attributes on an LDAP user entry will be interpreted as its OpenShift user name. + // userNameAttributes defines which attributes on an LDAP user entry will be interpreted as its OpenShift user name. UserNameAttributes []string `json:"userNameAttributes"` - // GroupMembershipAttributes defines which attributes on an LDAP user entry will be interpreted + // groupMembershipAttributes defines which attributes on an LDAP user entry will be interpreted // as the groups it is a member of GroupMembershipAttributes []string `json:"groupMembershipAttributes"` } @@ -1384,10 +1384,10 @@ type AugmentedActiveDirectoryConfig struct { // AllUsersQuery holds the template for an LDAP query that returns user entries. AllUsersQuery LDAPQuery `json:"usersQuery"` - // UserNameAttributes defines which attributes on an LDAP user entry will be interpreted as its OpenShift user name. + // userNameAttributes defines which attributes on an LDAP user entry will be interpreted as its OpenShift user name. UserNameAttributes []string `json:"userNameAttributes"` - // GroupMembershipAttributes defines which attributes on an LDAP user entry will be interpreted + // groupMembershipAttributes defines which attributes on an LDAP user entry will be interpreted // as the groups it is a member of GroupMembershipAttributes []string `json:"groupMembershipAttributes"` @@ -1398,7 +1398,7 @@ type AugmentedActiveDirectoryConfig struct { // (ldapGroupUID) GroupUIDAttribute string `json:"groupUIDAttribute"` - // GroupNameAttributes defines which attributes on an LDAP group entry will be interpreted as its name to use for + // groupNameAttributes defines which attributes on an LDAP group entry will be interpreted as its name to use for // an OpenShift group GroupNameAttributes []string `json:"groupNameAttributes"` } @@ -1427,45 +1427,45 @@ type LDAPQuery struct { // before the wait for a response is given up. If this is 0, no client-side limit is imposed TimeLimit int `json:"timeout"` - // Filter is a valid LDAP search filter that retrieves all relevant entries from the LDAP server with the base DN + // filter is a valid LDAP search filter that retrieves all relevant entries from the LDAP server with the base DN Filter string `json:"filter"` - // PageSize is the maximum preferred page size, measured in LDAP entries. A page size of 0 means no paging will be done. + // pageSize is the maximum preferred page size, measured in LDAP entries. A page size of 0 means no paging will be done. PageSize int `json:"pageSize"` } // AdmissionPluginConfig holds the necessary configuration options for admission plugins type AdmissionPluginConfig struct { - // Location is the path to a configuration file that contains the plugin's + // location is the path to a configuration file that contains the plugin's // configuration Location string `json:"location"` - // Configuration is an embedded configuration object to be used as the plugin's + // 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. Configuration runtime.RawExtension `json:"configuration"` } // AdmissionConfig holds the necessary configuration options for admission type AdmissionConfig struct { - // PluginConfig allows specifying a configuration file per admission control plugin + // pluginConfig allows specifying a configuration file per admission control plugin PluginConfig map[string]*AdmissionPluginConfig `json:"pluginConfig"` - // PluginOrderOverride is a list of admission control plugin names that will be installed + // 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. PluginOrderOverride []string `json:"pluginOrderOverride,omitempty"` } // ControllerConfig holds configuration values for controllers type ControllerConfig struct { - // Controllers is a list of controllers to enable. '*' enables all on-by-default controllers, 'foo' enables the controller "+ + // 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 "*". Controllers []string `json:"controllers"` - // Election defines the configuration for electing a controller instance to make changes to + // 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. Election *ControllerElectionConfig `json:"election"` - // ServiceServingCert holds configuration for service serving cert signer which creates cert/key pairs for + // serviceServingCert holds configuration for service serving cert signer which creates cert/key pairs for // pods fulfilling a service to serve with. ServiceServingCert ServiceServingCert `json:"serviceServingCert"` } @@ -1473,29 +1473,29 @@ type ControllerConfig struct { // ControllerElectionConfig contains configuration values for deciding how a controller // will be elected to act as leader. type ControllerElectionConfig struct { - // LockName is the resource name used to act as the lock for determining which controller + // lockName is the resource name used to act as the lock for determining which controller // instance should lead. LockName string `json:"lockName"` - // LockNamespace is the resource namespace used to act as the lock for determining which + // lockNamespace is the resource namespace used to act as the lock for determining which // controller instance should lead. It defaults to "kube-system" LockNamespace string `json:"lockNamespace"` - // LockResource is the group and resource name to use to coordinate for the controller lock. + // lockResource is the group and resource name to use to coordinate for the controller lock. // If unset, defaults to "configmaps". LockResource GroupResource `json:"lockResource"` } // GroupResource points to a resource by its name and API group. type GroupResource struct { - // Group is the name of an API group + // group is the name of an API group Group string `json:"group"` - // Resource is the name of a resource. + // resource is the name of a resource. Resource string `json:"resource"` } // ServiceServingCert holds configuration for service serving cert signer which creates cert/key pairs for // pods fulfilling a service to serve with. type ServiceServingCert struct { - // Signer holds the signing information used to automatically sign serving certificates. + // signer holds the signing information used to automatically sign serving certificates. // If this value is nil, then certs are not signed automatically. Signer *CertInfo `json:"signer"` } @@ -1512,7 +1512,7 @@ type ServiceServingCert struct { type DefaultAdmissionConfig struct { metav1.TypeMeta `json:",inline"` - // Disable turns off an admission plugin that is enabled by default. + // disable turns off an admission plugin that is enabled by default. Disable bool `json:"disable"` } diff --git a/legacyconfig/v1/zz_generated.swagger_doc_generated.go b/legacyconfig/v1/zz_generated.swagger_doc_generated.go index daa0868b6bb..42444e8aee3 100644 --- a/legacyconfig/v1/zz_generated.swagger_doc_generated.go +++ b/legacyconfig/v1/zz_generated.swagger_doc_generated.go @@ -14,8 +14,8 @@ package v1 var map_ActiveDirectoryConfig = map[string]string{ "": "ActiveDirectoryConfig holds the necessary configuration options to define how an LDAP group sync interacts with an LDAP server using the Active Directory schema", "usersQuery": "AllUsersQuery holds the template for an LDAP query that returns user entries.", - "userNameAttributes": "UserNameAttributes defines which attributes on an LDAP user entry will be interpreted as its OpenShift user name.", - "groupMembershipAttributes": "GroupMembershipAttributes defines which attributes on an LDAP user entry will be interpreted as the groups it is a member of", + "userNameAttributes": "userNameAttributes defines which attributes on an LDAP user entry will be interpreted as its OpenShift user name.", + "groupMembershipAttributes": "groupMembershipAttributes defines which attributes on an LDAP user entry will be interpreted as the groups it is a member of", } func (ActiveDirectoryConfig) SwaggerDoc() map[string]string { @@ -24,8 +24,8 @@ func (ActiveDirectoryConfig) SwaggerDoc() map[string]string { var map_AdmissionConfig = map[string]string{ "": "AdmissionConfig holds the necessary configuration options for admission", - "pluginConfig": "PluginConfig allows specifying a configuration file per admission control plugin", - "pluginOrderOverride": "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.", + "pluginConfig": "pluginConfig allows specifying a configuration file per admission control plugin", + "pluginOrderOverride": "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.", } func (AdmissionConfig) SwaggerDoc() map[string]string { @@ -34,8 +34,8 @@ func (AdmissionConfig) SwaggerDoc() map[string]string { var map_AdmissionPluginConfig = map[string]string{ "": "AdmissionPluginConfig holds the necessary configuration options for admission plugins", - "location": "Location is the path to a configuration file that contains the plugin's configuration", - "configuration": "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.", + "location": "location is the path to a configuration file that contains the plugin's configuration", + "configuration": "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.", } func (AdmissionPluginConfig) SwaggerDoc() map[string]string { @@ -44,7 +44,7 @@ func (AdmissionPluginConfig) SwaggerDoc() map[string]string { var map_AggregatorConfig = map[string]string{ "": "AggregatorConfig holds information required to make the aggregator function.", - "proxyClientInfo": "ProxyClientInfo specifies the client cert/key to use when proxying to aggregated API servers", + "proxyClientInfo": "proxyClientInfo specifies the client cert/key to use when proxying to aggregated API servers", } func (AggregatorConfig) SwaggerDoc() map[string]string { @@ -66,8 +66,8 @@ var map_AuditConfig = map[string]string{ "maximumFileRetentionDays": "Maximum number of days to retain old log files based on the timestamp encoded in their filename.", "maximumRetainedFiles": "Maximum number of old log files to retain.", "maximumFileSizeMegabytes": "Maximum size in megabytes of the log file before it gets rotated. Defaults to 100MB.", - "policyFile": "PolicyFile is a path to the file that defines the audit policy configuration.", - "policyConfiguration": "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.", + "policyFile": "policyFile is a path to the file that defines the audit policy configuration.", + "policyConfiguration": "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.", "logFormat": "Format of saved audits (legacy or json).", "webHookKubeConfig": "Path to a .kubeconfig formatted file that defines the audit webhook configuration.", "webHookMode": "Strategy for sending audit events (block or batch).", @@ -80,11 +80,11 @@ func (AuditConfig) SwaggerDoc() map[string]string { var map_AugmentedActiveDirectoryConfig = map[string]string{ "": "AugmentedActiveDirectoryConfig holds the necessary configuration options to define how an LDAP group sync interacts with an LDAP server using the augmented Active Directory schema", "usersQuery": "AllUsersQuery holds the template for an LDAP query that returns user entries.", - "userNameAttributes": "UserNameAttributes defines which attributes on an LDAP user entry will be interpreted as its OpenShift user name.", - "groupMembershipAttributes": "GroupMembershipAttributes defines which attributes on an LDAP user entry will be interpreted as the groups it is a member of", + "userNameAttributes": "userNameAttributes defines which attributes on an LDAP user entry will be interpreted as its OpenShift user name.", + "groupMembershipAttributes": "groupMembershipAttributes defines which attributes on an LDAP user entry will be interpreted as the groups it is a member of", "groupsQuery": "AllGroupsQuery holds the template for an LDAP query that returns group entries.", "groupUIDAttribute": "GroupUIDAttributes defines which attribute on an LDAP group entry will be interpreted as its unique identifier. (ldapGroupUID)", - "groupNameAttributes": "GroupNameAttributes defines which attributes on an LDAP group entry will be interpreted as its name to use for an OpenShift group", + "groupNameAttributes": "groupNameAttributes defines which attributes on an LDAP group entry will be interpreted as its name to use for an OpenShift group", } func (AugmentedActiveDirectoryConfig) SwaggerDoc() map[string]string { @@ -131,8 +131,8 @@ func (BuildOverridesConfig) SwaggerDoc() map[string]string { var map_CertInfo = map[string]string{ "": "CertInfo relates a certificate with a private key", - "certFile": "CertFile is a file containing a PEM-encoded certificate", - "keyFile": "KeyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile", + "certFile": "certFile is a file containing a PEM-encoded certificate", + "keyFile": "keyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile", } func (CertInfo) SwaggerDoc() map[string]string { @@ -141,10 +141,10 @@ func (CertInfo) SwaggerDoc() map[string]string { var map_ClientConnectionOverrides = map[string]string{ "": "ClientConnectionOverrides are a set of overrides to the default client connection settings.", - "acceptContentTypes": "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.", - "contentType": "ContentType is the content type used when sending data to the server from this client.", - "qps": "QPS controls the number of queries per second allowed for this connection.", - "burst": "Burst allows extra queries to accumulate when a client is exceeding its rate.", + "acceptContentTypes": "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.", + "contentType": "contentType is the content type used when sending data to the server from this client.", + "qps": "qps controls the number of queries per second allowed for this connection.", + "burst": "burst allows extra queries to accumulate when a client is exceeding its rate.", } func (ClientConnectionOverrides) SwaggerDoc() map[string]string { @@ -153,8 +153,8 @@ func (ClientConnectionOverrides) SwaggerDoc() map[string]string { var map_ClusterNetworkEntry = map[string]string{ "": "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.", - "cidr": "CIDR defines the total range of a cluster networks address space.", - "hostSubnetLength": "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.", + "cidr": "cidr defines the total range of a cluster networks address space.", + "hostSubnetLength": "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.", } func (ClusterNetworkEntry) SwaggerDoc() map[string]string { @@ -163,9 +163,9 @@ func (ClusterNetworkEntry) SwaggerDoc() map[string]string { var map_ControllerConfig = map[string]string{ "": "ControllerConfig holds configuration values for controllers", - "controllers": "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 \"*\".", - "election": "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.", - "serviceServingCert": "ServiceServingCert holds configuration for service serving cert signer which creates cert/key pairs for pods fulfilling a service to serve with.", + "controllers": "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 \"*\".", + "election": "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.", + "serviceServingCert": "serviceServingCert holds configuration for service serving cert signer which creates cert/key pairs for pods fulfilling a service to serve with.", } func (ControllerConfig) SwaggerDoc() map[string]string { @@ -174,9 +174,9 @@ func (ControllerConfig) SwaggerDoc() map[string]string { var map_ControllerElectionConfig = map[string]string{ "": "ControllerElectionConfig contains configuration values for deciding how a controller will be elected to act as leader.", - "lockName": "LockName is the resource name used to act as the lock for determining which controller instance should lead.", - "lockNamespace": "LockNamespace is the resource namespace used to act as the lock for determining which controller instance should lead. It defaults to \"kube-system\"", - "lockResource": "LockResource is the group and resource name to use to coordinate for the controller lock. If unset, defaults to \"configmaps\".", + "lockName": "lockName is the resource name used to act as the lock for determining which controller instance should lead.", + "lockNamespace": "lockNamespace is the resource namespace used to act as the lock for determining which controller instance should lead. It defaults to \"kube-system\"", + "lockResource": "lockResource is the group and resource name to use to coordinate for the controller lock. If unset, defaults to \"configmaps\".", } func (ControllerElectionConfig) SwaggerDoc() map[string]string { @@ -185,9 +185,9 @@ func (ControllerElectionConfig) SwaggerDoc() map[string]string { var map_DNSConfig = map[string]string{ "": "DNSConfig holds the necessary configuration options for DNS", - "bindAddress": "BindAddress is the ip:port to serve DNS on", - "bindNetwork": "BindNetwork is the type of network to bind to - defaults to \"tcp4\", accepts \"tcp\", \"tcp4\", and \"tcp6\"", - "allowRecursiveQueries": "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.", + "bindAddress": "bindAddress is the ip:port to serve DNS on", + "bindNetwork": "bindNetwork is the type of network to bind to - defaults to \"tcp4\", accepts \"tcp\", \"tcp4\", and \"tcp6\"", + "allowRecursiveQueries": "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.", } func (DNSConfig) SwaggerDoc() map[string]string { @@ -196,7 +196,7 @@ func (DNSConfig) SwaggerDoc() map[string]string { var map_DefaultAdmissionConfig = map[string]string{ "": "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.", - "disable": "Disable turns off an admission plugin that is enabled by default.", + "disable": "disable turns off an admission plugin that is enabled by default.", } func (DefaultAdmissionConfig) SwaggerDoc() map[string]string { @@ -213,9 +213,9 @@ func (DenyAllPasswordIdentityProvider) SwaggerDoc() map[string]string { var map_DockerConfig = map[string]string{ "": "DockerConfig holds Docker related configuration options.", - "execHandlerName": "ExecHandlerName is the name of the handler to use for executing commands in containers.", - "dockerShimSocket": "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'", - "dockerShimRootDirectory": "DockershimRootDirectory is the dockershim root directory.", + "execHandlerName": "execHandlerName is the name of the handler to use for executing commands in containers.", + "dockerShimSocket": "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'", + "dockerShimRootDirectory": "dockerShimRootDirectory is the dockershim root directory.", } func (DockerConfig) SwaggerDoc() map[string]string { @@ -224,10 +224,10 @@ func (DockerConfig) SwaggerDoc() map[string]string { var map_EtcdConfig = map[string]string{ "": "EtcdConfig holds the necessary configuration options for connecting with an etcd database", - "servingInfo": "ServingInfo describes how to start serving the etcd master", - "address": "Address is the advertised host:port for client connections to etcd", - "peerServingInfo": "PeerServingInfo describes how to start serving the etcd peer", - "peerAddress": "PeerAddress is the advertised host:port for peer connections to etcd", + "servingInfo": "servingInfo describes how to start serving the etcd master", + "address": "address is the advertised host:port for client connections to etcd", + "peerServingInfo": "peerServingInfo describes how to start serving the etcd peer", + "peerAddress": "peerAddress is the advertised host:port for peer connections to etcd", "storageDirectory": "StorageDir is the path to the etcd storage directory", } @@ -237,8 +237,8 @@ func (EtcdConfig) SwaggerDoc() map[string]string { var map_EtcdConnectionInfo = map[string]string{ "": "EtcdConnectionInfo holds information necessary for connecting to an etcd server", - "urls": "URLs are the URLs for etcd", - "ca": "CA is a file containing trusted roots for the etcd server certificates", + "urls": "urls are the URLs for etcd", + "ca": "ca is a file containing trusted roots for the etcd server certificates", } func (EtcdConnectionInfo) SwaggerDoc() map[string]string { @@ -247,10 +247,10 @@ func (EtcdConnectionInfo) SwaggerDoc() map[string]string { var map_EtcdStorageConfig = map[string]string{ "": "EtcdStorageConfig holds the necessary configuration options for the etcd storage underlying OpenShift and Kubernetes", - "kubernetesStorageVersion": "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.", - "kubernetesStoragePrefix": "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'.", - "openShiftStorageVersion": "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.", - "openShiftStoragePrefix": "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'.", + "kubernetesStorageVersion": "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.", + "kubernetesStoragePrefix": "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'.", + "openShiftStorageVersion": "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.", + "openShiftStoragePrefix": "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'.", } func (EtcdStorageConfig) SwaggerDoc() map[string]string { @@ -259,12 +259,12 @@ func (EtcdStorageConfig) SwaggerDoc() map[string]string { var map_GitHubIdentityProvider = map[string]string{ "": "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.", - "clientID": "ClientID is the oauth client ID", - "clientSecret": "ClientSecret is the oauth client secret", - "organizations": "Organizations optionally restricts which organizations are allowed to log in", - "teams": "Teams optionally restricts which teams are allowed to log in. Format is /.", - "hostname": "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.", - "ca": "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.", + "clientID": "clientID is the oauth client ID", + "clientSecret": "clientSecret is the oauth client secret", + "organizations": "organizations optionally restricts which organizations are allowed to log in", + "teams": "teams optionally restricts which teams are allowed to log in. Format is /.", + "hostname": "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.", + "ca": "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.", } func (GitHubIdentityProvider) SwaggerDoc() map[string]string { @@ -273,11 +273,11 @@ func (GitHubIdentityProvider) SwaggerDoc() map[string]string { var map_GitLabIdentityProvider = map[string]string{ "": "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.", - "ca": "CA is the optional trusted certificate authority bundle to use when making requests to the server If empty, the default system roots are used", - "url": "URL is the oauth server base URL", - "clientID": "ClientID is the oauth client ID", - "clientSecret": "ClientSecret is the oauth client secret", - "legacy": "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", + "ca": "ca is the optional trusted certificate authority bundle to use when making requests to the server If empty, the default system roots are used", + "url": "url is the oauth server base URL", + "clientID": "clientID is the oauth client ID", + "clientSecret": "clientSecret is the oauth client secret", + "legacy": "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", } func (GitLabIdentityProvider) SwaggerDoc() map[string]string { @@ -286,9 +286,9 @@ func (GitLabIdentityProvider) SwaggerDoc() map[string]string { var map_GoogleIdentityProvider = map[string]string{ "": "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.", - "clientID": "ClientID is the oauth client ID", - "clientSecret": "ClientSecret is the oauth client secret", - "hostedDomain": "HostedDomain is the optional Google App domain (e.g. \"mycompany.com\") to restrict logins to", + "clientID": "clientID is the oauth client ID", + "clientSecret": "clientSecret is the oauth client secret", + "hostedDomain": "hostedDomain is the optional Google App domain (e.g. \"mycompany.com\") to restrict logins to", } func (GoogleIdentityProvider) SwaggerDoc() map[string]string { @@ -297,8 +297,8 @@ func (GoogleIdentityProvider) SwaggerDoc() map[string]string { var map_GrantConfig = map[string]string{ "": "GrantConfig holds the necessary configuration options for grant handlers", - "method": "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", - "serviceAccountMethod": "ServiceAccountMethod is used for determining client authorization for service account oauth client. It must be either: deny, prompt", + "method": "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", + "serviceAccountMethod": "serviceAccountMethod is used for determining client authorization for service account oauth client. It must be either: deny, prompt", } func (GrantConfig) SwaggerDoc() map[string]string { @@ -307,8 +307,8 @@ func (GrantConfig) SwaggerDoc() map[string]string { var map_GroupResource = map[string]string{ "": "GroupResource points to a resource by its name and API group.", - "group": "Group is the name of an API group", - "resource": "Resource is the name of a resource.", + "group": "group is the name of an API group", + "resource": "resource is the name of a resource.", } func (GroupResource) SwaggerDoc() map[string]string { @@ -317,7 +317,7 @@ func (GroupResource) SwaggerDoc() map[string]string { var map_HTPasswdPasswordIdentityProvider = map[string]string{ "": "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.", - "file": "File is a reference to your htpasswd file", + "file": "file is a reference to your htpasswd file", } func (HTPasswdPasswordIdentityProvider) SwaggerDoc() map[string]string { @@ -326,8 +326,8 @@ func (HTPasswdPasswordIdentityProvider) SwaggerDoc() map[string]string { var map_HTTPServingInfo = map[string]string{ "": "HTTPServingInfo holds configuration for serving HTTP", - "maxRequestsInFlight": "MaxRequestsInFlight is the number of concurrent requests allowed to the server. If zero, no limit.", - "requestTimeoutSeconds": "RequestTimeoutSeconds is the number of seconds before requests are timed out. The default is 60 minutes, if -1 there is no limit on requests.", + "maxRequestsInFlight": "maxRequestsInFlight is the number of concurrent requests allowed to the server. If zero, no limit.", + "requestTimeoutSeconds": "requestTimeoutSeconds is the number of seconds before requests are timed out. The default is 60 minutes, if -1 there is no limit on requests.", } func (HTTPServingInfo) SwaggerDoc() map[string]string { @@ -336,11 +336,11 @@ func (HTTPServingInfo) SwaggerDoc() map[string]string { var map_IdentityProvider = map[string]string{ "": "IdentityProvider provides identities for users authenticating using credentials", - "name": "Name is used to qualify the identities returned by this provider", + "name": "name is used to qualify the identities returned by this provider", "challenge": "UseAsChallenger indicates whether to issue WWW-Authenticate challenges for this provider", "login": "UseAsLogin indicates whether to use this identity provider for unauthenticated browsers to login against", - "mappingMethod": "MappingMethod determines how identities from this provider are mapped to users", - "provider": "Provider contains the information about how to set up a specific identity provider", + "mappingMethod": "mappingMethod determines how identities from this provider are mapped to users", + "provider": "provider contains the information about how to set up a specific identity provider", } func (IdentityProvider) SwaggerDoc() map[string]string { @@ -349,8 +349,8 @@ func (IdentityProvider) SwaggerDoc() map[string]string { var map_ImageConfig = map[string]string{ "": "ImageConfig holds the necessary configuration options for building image names for system components", - "format": "Format is the format of the name to be built for the system component", - "latest": "Latest determines if the latest tag will be pulled from the registry", + "format": "format is the format of the name to be built for the system component", + "latest": "latest determines if the latest tag will be pulled from the registry", } func (ImageConfig) SwaggerDoc() map[string]string { @@ -359,14 +359,14 @@ func (ImageConfig) SwaggerDoc() map[string]string { var map_ImagePolicyConfig = map[string]string{ "": "ImagePolicyConfig holds the necessary configuration options for limits and behavior for importing images", - "maxImagesBulkImportedPerRepository": "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.", - "disableScheduledImport": "DisableScheduledImport allows scheduled background import of images to be disabled.", - "scheduledImageImportMinimumIntervalSeconds": "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.", - "maxScheduledImageImportsPerMinute": "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.", - "allowedRegistriesForImport": "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.", - "internalRegistryHostname": "InternalRegistryHostname sets the hostname for the default internal image registry. The value must be in \"hostname[:port]\" format.", - "externalRegistryHostname": "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.", - "additionalTrustedCA": "AdditionalTrustedCA is a path to a pem bundle file containing additional CAs that should be trusted during imagestream import.", + "maxImagesBulkImportedPerRepository": "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.", + "disableScheduledImport": "disableScheduledImport allows scheduled background import of images to be disabled.", + "scheduledImageImportMinimumIntervalSeconds": "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.", + "maxScheduledImageImportsPerMinute": "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.", + "allowedRegistriesForImport": "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.", + "internalRegistryHostname": "internalRegistryHostname sets the hostname for the default internal image registry. The value must be in \"hostname[:port]\" format.", + "externalRegistryHostname": "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.", + "additionalTrustedCA": "additionalTrustedCA is a path to a pem bundle file containing additional CAs that should be trusted during imagestream import.", } func (ImagePolicyConfig) SwaggerDoc() map[string]string { @@ -375,11 +375,11 @@ func (ImagePolicyConfig) SwaggerDoc() map[string]string { var map_JenkinsPipelineConfig = map[string]string{ "": "JenkinsPipelineConfig holds configuration for the Jenkins pipeline strategy", - "autoProvisionEnabled": "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.", - "templateNamespace": "TemplateNamespace contains the namespace name where the Jenkins template is stored", - "templateName": "TemplateName is the name of the default Jenkins template", - "serviceName": "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.", - "parameters": "Parameters specifies a set of optional parameters to the Jenkins template.", + "autoProvisionEnabled": "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.", + "templateNamespace": "templateNamespace contains the namespace name where the Jenkins template is stored", + "templateName": "templateName is the name of the default Jenkins template", + "serviceName": "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.", + "parameters": "parameters specifies a set of optional parameters to the Jenkins template.", } func (JenkinsPipelineConfig) SwaggerDoc() map[string]string { @@ -389,7 +389,7 @@ func (JenkinsPipelineConfig) SwaggerDoc() map[string]string { var map_KeystonePasswordIdentityProvider = map[string]string{ "": "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.", "domainName": "Domain Name is required for keystone v3", - "useKeystoneIdentity": "UseKeystoneIdentity flag indicates that user should be authenticated by keystone ID, not by username", + "useKeystoneIdentity": "useKeystoneIdentity flag indicates that user should be authenticated by keystone ID, not by username", } func (KeystonePasswordIdentityProvider) SwaggerDoc() map[string]string { @@ -398,8 +398,8 @@ func (KeystonePasswordIdentityProvider) SwaggerDoc() map[string]string { var map_KubeletConnectionInfo = map[string]string{ "": "KubeletConnectionInfo holds information necessary for connecting to a kubelet", - "port": "Port is the port to connect to kubelets on", - "ca": "CA is the CA for verifying TLS connections to kubelets", + "port": "port is the port to connect to kubelets on", + "ca": "ca is the CA for verifying TLS connections to kubelets", } func (KubeletConnectionInfo) SwaggerDoc() map[string]string { @@ -408,18 +408,18 @@ func (KubeletConnectionInfo) SwaggerDoc() map[string]string { var map_KubernetesMasterConfig = map[string]string{ "": "KubernetesMasterConfig holds the necessary configuration options for the Kubernetes master", - "apiLevels": "APILevels is a list of API levels that should be enabled on startup: v1 as examples", - "disabledAPIGroupVersions": "DisabledAPIGroupVersions is a map of groups to the versions (or *) that should be disabled.", - "masterIP": "MasterIP is the public IP address of kubernetes stuff. If empty, the first result from net.InterfaceAddrs will be used.", - "masterEndpointReconcileTTL": "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.", - "servicesSubnet": "ServicesSubnet is the subnet to use for assigning service IPs", - "servicesNodePortRange": "ServicesNodePortRange is the range to use for assigning service public ports on a host.", - "schedulerConfigFile": "SchedulerConfigFile points to a file that describes how to set up the scheduler. If empty, you get the default scheduling rules.", - "podEvictionTimeout": "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.", - "proxyClientInfo": "ProxyClientInfo specifies the client cert/key to use when proxying to pods", - "apiServerArguments": "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.", - "controllerArguments": "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.", - "schedulerArguments": "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.", + "apiLevels": "apiLevels is a list of API levels that should be enabled on startup: v1 as examples", + "disabledAPIGroupVersions": "disabledAPIGroupVersions is a map of groups to the versions (or *) that should be disabled.", + "masterIP": "masterIP is the public IP address of kubernetes stuff. If empty, the first result from net.InterfaceAddrs will be used.", + "masterEndpointReconcileTTL": "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.", + "servicesSubnet": "servicesSubnet is the subnet to use for assigning service IPs", + "servicesNodePortRange": "servicesNodePortRange is the range to use for assigning service public ports on a host.", + "schedulerConfigFile": "schedulerConfigFile points to a file that describes how to set up the scheduler. If empty, you get the default scheduling rules.", + "podEvictionTimeout": "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.", + "proxyClientInfo": "proxyClientInfo specifies the client cert/key to use when proxying to pods", + "apiServerArguments": "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.", + "controllerArguments": "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.", + "schedulerArguments": "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.", } func (KubernetesMasterConfig) SwaggerDoc() map[string]string { @@ -428,10 +428,10 @@ func (KubernetesMasterConfig) SwaggerDoc() map[string]string { var map_LDAPAttributeMapping = map[string]string{ "": "LDAPAttributeMapping maps LDAP attributes to OpenShift identity fields", - "id": "ID is the list of attributes whose values should be used as the user ID. Required. LDAP standard identity attribute is \"dn\"", - "preferredUsername": "PreferredUsername is the list of attributes whose values should be used as the preferred username. LDAP standard login attribute is \"uid\"", - "name": "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\"", - "email": "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", + "id": "id is the list of attributes whose values should be used as the user ID. Required. LDAP standard identity attribute is \"dn\"", + "preferredUsername": "preferredUsername is the list of attributes whose values should be used as the preferred username. LDAP standard login attribute is \"uid\"", + "name": "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\"", + "email": "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", } func (LDAPAttributeMapping) SwaggerDoc() map[string]string { @@ -440,12 +440,12 @@ func (LDAPAttributeMapping) SwaggerDoc() map[string]string { var map_LDAPPasswordIdentityProvider = map[string]string{ "": "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.", - "url": "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", - "bindDN": "BindDN is an optional DN to bind with during the search phase.", - "bindPassword": "BindPassword is an optional password to bind with during the search phase.", + "url": "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", + "bindDN": "bindDN is an optional DN to bind with during the search phase.", + "bindPassword": "bindPassword is an optional password to bind with during the search phase.", "insecure": "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", - "ca": "CA is the optional trusted certificate authority bundle to use when making requests to the server If empty, the default system roots are used", - "attributes": "Attributes maps LDAP attributes to identities", + "ca": "ca is the optional trusted certificate authority bundle to use when making requests to the server If empty, the default system roots are used", + "attributes": "attributes maps LDAP attributes to identities", } func (LDAPPasswordIdentityProvider) SwaggerDoc() map[string]string { @@ -458,8 +458,8 @@ var map_LDAPQuery = map[string]string{ "scope": "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", "derefAliases": "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", "timeout": "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", - "filter": "Filter is a valid LDAP search filter that retrieves all relevant entries from the LDAP server with the base DN", - "pageSize": "PageSize is the maximum preferred page size, measured in LDAP entries. A page size of 0 means no paging will be done.", + "filter": "filter is a valid LDAP search filter that retrieves all relevant entries from the LDAP server with the base DN", + "pageSize": "pageSize is the maximum preferred page size, measured in LDAP entries. A page size of 0 means no paging will be done.", } func (LDAPQuery) SwaggerDoc() map[string]string { @@ -469,10 +469,10 @@ func (LDAPQuery) SwaggerDoc() map[string]string { var map_LDAPSyncConfig = map[string]string{ "": "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.", "url": "Host is the scheme, host and port of the LDAP server to connect to: scheme://host:port", - "bindDN": "BindDN is an optional DN to bind to the LDAP server with", - "bindPassword": "BindPassword is an optional password to bind with during the search phase.", + "bindDN": "bindDN is an optional DN to bind to the LDAP server with", + "bindPassword": "bindPassword is an optional password to bind with during the search phase.", "insecure": "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", - "ca": "CA is the optional trusted certificate authority bundle to use when making requests to the server If empty, the default system roots are used", + "ca": "ca is the optional trusted certificate authority bundle to use when making requests to the server If empty, the default system roots are used", "groupUIDNameMapping": "LDAPGroupUIDToOpenShiftGroupNameMapping is an optional direct mapping of LDAP group UIDs to OpenShift Group names", "rfc2307": "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", "activeDirectory": "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", @@ -494,9 +494,9 @@ func (LocalQuota) SwaggerDoc() map[string]string { var map_MasterAuthConfig = map[string]string{ "": "MasterAuthConfig configures authentication options in addition to the standard oauth token and client certificate authenticators", - "requestHeader": "RequestHeader holds options for setting up a front proxy against the API. It is optional.", + "requestHeader": "requestHeader holds options for setting up a front proxy against the API. It is optional.", "webhookTokenAuthenticators": "WebhookTokenAuthnConfig, if present configures remote token reviewers", - "oauthMetadataFile": "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", + "oauthMetadataFile": "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", } func (MasterAuthConfig) SwaggerDoc() map[string]string { @@ -505,8 +505,8 @@ func (MasterAuthConfig) SwaggerDoc() map[string]string { var map_MasterClients = map[string]string{ "": "MasterClients holds references to `.kubeconfig` files that qualify master clients for OpenShift and Kubernetes", - "openshiftLoopbackKubeConfig": "OpenShiftLoopbackKubeConfig is a .kubeconfig filename for system components to loopback to this master", - "openshiftLoopbackClientConnectionOverrides": "OpenShiftLoopbackClientConnectionOverrides specifies client overrides for system components to loop back to this master.", + "openshiftLoopbackKubeConfig": "openshiftLoopbackKubeConfig is a .kubeconfig filename for system components to loopback to this master", + "openshiftLoopbackClientConnectionOverrides": "openshiftLoopbackClientConnectionOverrides specifies client overrides for system components to loop back to this master.", } func (MasterClients) SwaggerDoc() map[string]string { @@ -515,33 +515,33 @@ func (MasterClients) SwaggerDoc() map[string]string { var map_MasterConfig = map[string]string{ "": "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.", - "servingInfo": "ServingInfo describes how to start serving", - "authConfig": "AuthConfig configures authentication options in addition to the standard oauth token and client certificate authenticators", - "aggregatorConfig": "AggregatorConfig has options for configuring the aggregator component of the API server.", + "servingInfo": "servingInfo describes how to start serving", + "authConfig": "authConfig configures authentication options in addition to the standard oauth token and client certificate authenticators", + "aggregatorConfig": "aggregatorConfig has options for configuring the aggregator component of the API server.", "corsAllowedOrigins": "CORSAllowedOrigins", - "apiLevels": "APILevels is a list of API levels that should be enabled on startup: v1 as examples", - "masterPublicURL": "MasterPublicURL is how clients can access the OpenShift API server", - "controllers": "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.", - "admissionConfig": "AdmissionConfig contains admission control plugin configuration.", - "controllerConfig": "ControllerConfig holds configuration values for controllers", - "etcdStorageConfig": "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.", - "etcdClientInfo": "EtcdClientInfo contains information about how to connect to etcd", - "kubeletClientInfo": "KubeletClientInfo contains information about how to connect to kubelets", + "apiLevels": "apiLevels is a list of API levels that should be enabled on startup: v1 as examples", + "masterPublicURL": "masterPublicURL is how clients can access the OpenShift API server", + "controllers": "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.", + "admissionConfig": "admissionConfig contains admission control plugin configuration.", + "controllerConfig": "controllerConfig holds configuration values for controllers", + "etcdStorageConfig": "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.", + "etcdClientInfo": "etcdClientInfo contains information about how to connect to etcd", + "kubeletClientInfo": "kubeletClientInfo contains information about how to connect to kubelets", "kubernetesMasterConfig": "KubernetesMasterConfig, if present start the kubernetes master in this process", "etcdConfig": "EtcdConfig, if present start etcd in this process", "oauthConfig": "OAuthConfig, if present start the /oauth endpoint in this process", "dnsConfig": "DNSConfig, if present start the DNS server in this process", - "serviceAccountConfig": "ServiceAccountConfig holds options related to service accounts", - "masterClients": "MasterClients holds all the client connection information for controllers and other system components", - "imageConfig": "ImageConfig holds options that describe how to build image names for system components", - "imagePolicyConfig": "ImagePolicyConfig controls limits and behavior for importing images", - "policyConfig": "PolicyConfig holds information about where to locate critical pieces of bootstrapping policy", - "projectConfig": "ProjectConfig holds information about project creation and defaults", - "routingConfig": "RoutingConfig holds information about routing and route generation", - "networkConfig": "NetworkConfig to be passed to the compiled in network plugin", + "serviceAccountConfig": "serviceAccountConfig holds options related to service accounts", + "masterClients": "masterClients holds all the client connection information for controllers and other system components", + "imageConfig": "imageConfig holds options that describe how to build image names for system components", + "imagePolicyConfig": "imagePolicyConfig controls limits and behavior for importing images", + "policyConfig": "policyConfig holds information about where to locate critical pieces of bootstrapping policy", + "projectConfig": "projectConfig holds information about project creation and defaults", + "routingConfig": "routingConfig holds information about routing and route generation", + "networkConfig": "networkConfig to be passed to the compiled in network plugin", "volumeConfig": "MasterVolumeConfig contains options for configuring volume plugins in the master node.", - "jenkinsPipelineConfig": "JenkinsPipelineConfig holds information about the default Jenkins template used for JenkinsPipeline build strategy.", - "auditConfig": "AuditConfig holds information related to auditing capabilities.", + "jenkinsPipelineConfig": "jenkinsPipelineConfig holds information about the default Jenkins template used for JenkinsPipeline build strategy.", + "auditConfig": "auditConfig holds information related to auditing capabilities.", } func (MasterConfig) SwaggerDoc() map[string]string { @@ -550,14 +550,14 @@ func (MasterConfig) SwaggerDoc() map[string]string { var map_MasterNetworkConfig = map[string]string{ "": "MasterNetworkConfig to be passed to the compiled in network plugin", - "networkPluginName": "NetworkPluginName is the name of the network plugin to use", - "clusterNetworkCIDR": "ClusterNetworkCIDR is the CIDR string to specify the global overlay network's L3 space. Deprecated, but maintained for backwards compatibility, use ClusterNetworks instead.", - "clusterNetworks": "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.", - "hostSubnetLength": "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.", + "networkPluginName": "networkPluginName is the name of the network plugin to use", + "clusterNetworkCIDR": "clusterNetworkCIDR is the CIDR string to specify the global overlay network's L3 space. Deprecated, but maintained for backwards compatibility, use ClusterNetworks instead.", + "clusterNetworks": "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.", + "hostSubnetLength": "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.", "serviceNetworkCIDR": "ServiceNetwork is the CIDR string to specify the service networks", - "externalIPNetworkCIDRs": "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.", - "ingressIPNetworkCIDR": "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.", - "vxlanPort": "VXLANPort is the VXLAN port used by the cluster defaults. If it is not set, 4789 is the default value", + "externalIPNetworkCIDRs": "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.", + "ingressIPNetworkCIDR": "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.", + "vxlanPort": "vxlanPort is the VXLAN port used by the cluster defaults. If it is not set, 4789 is the default value", } func (MasterNetworkConfig) SwaggerDoc() map[string]string { @@ -566,7 +566,7 @@ func (MasterNetworkConfig) SwaggerDoc() map[string]string { var map_MasterVolumeConfig = map[string]string{ "": "MasterVolumeConfig contains options for configuring volume plugins in the master node.", - "dynamicProvisioningEnabled": "DynamicProvisioningEnabled is a boolean that toggles dynamic provisioning off when false, defaults to true", + "dynamicProvisioningEnabled": "dynamicProvisioningEnabled is a boolean that toggles dynamic provisioning off when false, defaults to true", } func (MasterVolumeConfig) SwaggerDoc() map[string]string { @@ -575,7 +575,7 @@ func (MasterVolumeConfig) SwaggerDoc() map[string]string { var map_NamedCertificate = map[string]string{ "": "NamedCertificate specifies a certificate/key, and the names it should be served for", - "names": "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.", + "names": "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.", } func (NamedCertificate) SwaggerDoc() map[string]string { @@ -584,10 +584,10 @@ func (NamedCertificate) SwaggerDoc() map[string]string { var map_NodeAuthConfig = map[string]string{ "": "NodeAuthConfig holds authn/authz configuration options", - "authenticationCacheTTL": "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", - "authenticationCacheSize": "AuthenticationCacheSize indicates how many authentication results should be cached. If 0, the default cache size is used.", - "authorizationCacheTTL": "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", - "authorizationCacheSize": "AuthorizationCacheSize indicates how many authorization results should be cached. If 0, the default cache size is used.", + "authenticationCacheTTL": "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", + "authenticationCacheSize": "authenticationCacheSize indicates how many authentication results should be cached. If 0, the default cache size is used.", + "authorizationCacheTTL": "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", + "authorizationCacheSize": "authorizationCacheSize indicates how many authorization results should be cached. If 0, the default cache size is used.", } func (NodeAuthConfig) SwaggerDoc() map[string]string { @@ -596,29 +596,29 @@ func (NodeAuthConfig) SwaggerDoc() map[string]string { var map_NodeConfig = map[string]string{ "": "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.", - "nodeName": "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", + "nodeName": "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", "nodeIP": "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", - "servingInfo": "ServingInfo describes how to start serving", - "masterKubeConfig": "MasterKubeConfig is a filename for the .kubeconfig file that describes how to connect this node to the master", - "masterClientConnectionOverrides": "MasterClientConnectionOverrides provides overrides to the client connection used to connect to the master.", - "dnsDomain": "DNSDomain holds the domain suffix that will be used for the DNS search path inside each container. Defaults to 'cluster.local'.", - "dnsIP": "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.", - "dnsBindAddress": "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.", - "dnsNameservers": "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.", - "dnsRecursiveResolvConf": "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.", + "servingInfo": "servingInfo describes how to start serving", + "masterKubeConfig": "masterKubeConfig is a filename for the .kubeconfig file that describes how to connect this node to the master", + "masterClientConnectionOverrides": "masterClientConnectionOverrides provides overrides to the client connection used to connect to the master.", + "dnsDomain": "dnsDomain holds the domain suffix that will be used for the DNS search path inside each container. Defaults to 'cluster.local'.", + "dnsIP": "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.", + "dnsBindAddress": "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.", + "dnsNameservers": "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.", + "dnsRecursiveResolvConf": "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.", "networkPluginName": "Deprecated and maintained for backward compatibility, use NetworkConfig.NetworkPluginName instead", - "networkConfig": "NetworkConfig provides network options for the node", - "volumeDirectory": "VolumeDirectory is the directory that volumes will be stored under", - "imageConfig": "ImageConfig holds options that describe how to build image names for system components", - "allowDisabledDocker": "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.", - "podManifestConfig": "PodManifestConfig holds the configuration for enabling the Kubelet to create pods based from a manifest file(s) placed locally on the node", - "authConfig": "AuthConfig holds authn/authz configuration options", - "dockerConfig": "DockerConfig holds Docker related configuration options.", - "kubeletArguments": "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.", - "proxyArguments": "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.", - "iptablesSyncPeriod": "IPTablesSyncPeriod is how often iptable rules are refreshed", - "enableUnidling": "EnableUnidling controls whether or not the hybrid unidling proxy will be set up", - "volumeConfig": "VolumeConfig contains options for configuring volumes on the node.", + "networkConfig": "networkConfig provides network options for the node", + "volumeDirectory": "volumeDirectory is the directory that volumes will be stored under", + "imageConfig": "imageConfig holds options that describe how to build image names for system components", + "allowDisabledDocker": "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.", + "podManifestConfig": "podManifestConfig holds the configuration for enabling the Kubelet to create pods based from a manifest file(s) placed locally on the node", + "authConfig": "authConfig holds authn/authz configuration options", + "dockerConfig": "dockerConfig holds Docker related configuration options.", + "kubeletArguments": "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.", + "proxyArguments": "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.", + "iptablesSyncPeriod": "iptablesSyncPeriod is how often iptable rules are refreshed", + "enableUnidling": "enableUnidling controls whether or not the hybrid unidling proxy will be set up", + "volumeConfig": "volumeConfig contains options for configuring volumes on the node.", } func (NodeConfig) SwaggerDoc() map[string]string { @@ -627,7 +627,7 @@ func (NodeConfig) SwaggerDoc() map[string]string { var map_NodeNetworkConfig = map[string]string{ "": "NodeNetworkConfig provides network options for the node", - "networkPluginName": "NetworkPluginName is a string specifying the networking plugin", + "networkPluginName": "networkPluginName is a string specifying the networking plugin", "mtu": "Maximum transmission unit for the network packets", } @@ -637,7 +637,7 @@ func (NodeNetworkConfig) SwaggerDoc() map[string]string { var map_NodeVolumeConfig = map[string]string{ "": "NodeVolumeConfig contains options for configuring volumes on the node.", - "localQuota": "LocalQuota contains options for controlling local volume quota on the node.", + "localQuota": "localQuota contains options for controlling local volume quota on the node.", } func (NodeVolumeConfig) SwaggerDoc() map[string]string { @@ -646,16 +646,16 @@ func (NodeVolumeConfig) SwaggerDoc() map[string]string { var map_OAuthConfig = map[string]string{ "": "OAuthConfig holds the necessary configuration options for OAuth authentication", - "masterCA": "MasterCA is the CA for verifying the TLS connection back to the MasterURL.", - "masterURL": "MasterURL is used for making server-to-server calls to exchange authorization codes for access tokens", - "masterPublicURL": "MasterPublicURL is used for building valid client redirect URLs for internal and external access", - "assetPublicURL": "AssetPublicURL is used for building valid client redirect URLs for external access", - "alwaysShowProviderSelection": "AlwaysShowProviderSelection will force the provider selection page to render even when there is only a single provider.", - "identityProviders": "IdentityProviders is an ordered list of ways for a user to identify themselves", - "grantConfig": "GrantConfig describes how to handle grants", - "sessionConfig": "SessionConfig hold information about configuring sessions.", - "tokenConfig": "TokenConfig contains options for authorization and access tokens", - "templates": "Templates allow you to customize pages like the login page.", + "masterCA": "masterCA is the CA for verifying the TLS connection back to the MasterURL.", + "masterURL": "masterURL is used for making server-to-server calls to exchange authorization codes for access tokens", + "masterPublicURL": "masterPublicURL is used for building valid client redirect URLs for internal and external access", + "assetPublicURL": "assetPublicURL is used for building valid client redirect URLs for external access", + "alwaysShowProviderSelection": "alwaysShowProviderSelection will force the provider selection page to render even when there is only a single provider.", + "identityProviders": "identityProviders is an ordered list of ways for a user to identify themselves", + "grantConfig": "grantConfig describes how to handle grants", + "sessionConfig": "sessionConfig hold information about configuring sessions.", + "tokenConfig": "tokenConfig contains options for authorization and access tokens", + "templates": "templates allow you to customize pages like the login page.", } func (OAuthConfig) SwaggerDoc() map[string]string { @@ -664,9 +664,9 @@ func (OAuthConfig) SwaggerDoc() map[string]string { var map_OAuthTemplates = map[string]string{ "": "OAuthTemplates allow for customization of pages like the login page", - "login": "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.", - "providerSelection": "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.", - "error": "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.", + "login": "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.", + "providerSelection": "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.", + "error": "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.", } func (OAuthTemplates) SwaggerDoc() map[string]string { @@ -675,10 +675,10 @@ func (OAuthTemplates) SwaggerDoc() map[string]string { var map_OpenIDClaims = map[string]string{ "": "OpenIDClaims contains a list of OpenID claims to use when authenticating with an OpenID identity provider", - "id": "ID is the list of claims whose values should be used as the user ID. Required. OpenID standard identity claim is \"sub\"", - "preferredUsername": "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", - "name": "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", - "email": "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", + "id": "id is the list of claims whose values should be used as the user ID. Required. OpenID standard identity claim is \"sub\"", + "preferredUsername": "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", + "name": "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", + "email": "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", } func (OpenIDClaims) SwaggerDoc() map[string]string { @@ -687,13 +687,13 @@ func (OpenIDClaims) SwaggerDoc() map[string]string { var map_OpenIDIdentityProvider = map[string]string{ "": "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.", - "ca": "CA is the optional trusted certificate authority bundle to use when making requests to the server If empty, the default system roots are used", - "clientID": "ClientID is the oauth client ID", - "clientSecret": "ClientSecret is the oauth client secret", - "extraScopes": "ExtraScopes are any scopes to request in addition to the standard \"openid\" scope.", - "extraAuthorizeParameters": "ExtraAuthorizeParameters are any custom parameters to add to the authorize request.", - "urls": "URLs to use to authenticate", - "claims": "Claims mappings", + "ca": "ca is the optional trusted certificate authority bundle to use when making requests to the server If empty, the default system roots are used", + "clientID": "clientID is the oauth client ID", + "clientSecret": "clientSecret is the oauth client secret", + "extraScopes": "extraScopes are any scopes to request in addition to the standard \"openid\" scope.", + "extraAuthorizeParameters": "extraAuthorizeParameters are any custom parameters to add to the authorize request.", + "urls": "urls to use to authenticate", + "claims": "claims mappings", } func (OpenIDIdentityProvider) SwaggerDoc() map[string]string { @@ -702,9 +702,9 @@ func (OpenIDIdentityProvider) SwaggerDoc() map[string]string { var map_OpenIDURLs = map[string]string{ "": "OpenIDURLs are URLs to use when authenticating with an OpenID identity provider", - "authorize": "Authorize is the oauth authorization URL", - "token": "Token is the oauth token granting URL", - "userInfo": "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", + "authorize": "authorize is the oauth authorization URL", + "token": "token is the oauth token granting URL", + "userInfo": "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", } func (OpenIDURLs) SwaggerDoc() map[string]string { @@ -713,8 +713,8 @@ func (OpenIDURLs) SwaggerDoc() map[string]string { var map_PodManifestConfig = map[string]string{ "": "PodManifestConfig holds the necessary configuration options for using pod manifests", - "path": "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", - "fileCheckIntervalSeconds": "FileCheckIntervalSeconds is the interval in seconds for checking the manifest file(s) for new data The interval needs to be a positive value", + "path": "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", + "fileCheckIntervalSeconds": "fileCheckIntervalSeconds is the interval in seconds for checking the manifest file(s) for new data The interval needs to be a positive value", } func (PodManifestConfig) SwaggerDoc() map[string]string { @@ -723,7 +723,7 @@ func (PodManifestConfig) SwaggerDoc() map[string]string { var map_PolicyConfig = map[string]string{ "": "holds the necessary configuration options for", - "userAgentMatchingConfig": "UserAgentMatchingConfig controls how API calls from *voluntarily* identifying clients will be handled. THIS DOES NOT DEFEND AGAINST MALICIOUS CLIENTS!", + "userAgentMatchingConfig": "userAgentMatchingConfig controls how API calls from *voluntarily* identifying clients will be handled. THIS DOES NOT DEFEND AGAINST MALICIOUS CLIENTS!", } func (PolicyConfig) SwaggerDoc() map[string]string { @@ -732,10 +732,10 @@ func (PolicyConfig) SwaggerDoc() map[string]string { var map_ProjectConfig = map[string]string{ "": "holds the necessary configuration options for", - "defaultNodeSelector": "DefaultNodeSelector holds default project node label selector", - "projectRequestMessage": "ProjectRequestMessage is the string presented to a user if they are unable to request a project via the projectrequest api endpoint", - "projectRequestTemplate": "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.", - "securityAllocator": "SecurityAllocator controls the automatic allocation of UIDs and MCS labels to a project. If nil, allocation is disabled.", + "defaultNodeSelector": "defaultNodeSelector holds default project node label selector", + "projectRequestMessage": "projectRequestMessage is the string presented to a user if they are unable to request a project via the projectrequest api endpoint", + "projectRequestTemplate": "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.", + "securityAllocator": "securityAllocator controls the automatic allocation of UIDs and MCS labels to a project. If nil, allocation is disabled.", } func (ProjectConfig) SwaggerDoc() map[string]string { @@ -746,13 +746,13 @@ var map_RFC2307Config = map[string]string{ "": "RFC2307Config holds the necessary configuration options to define how an LDAP group sync interacts with an LDAP server using the RFC2307 schema", "groupsQuery": "AllGroupsQuery holds the template for an LDAP query that returns group entries.", "groupUIDAttribute": "GroupUIDAttributes defines which attribute on an LDAP group entry will be interpreted as its unique identifier. (ldapGroupUID)", - "groupNameAttributes": "GroupNameAttributes defines which attributes on an LDAP group entry will be interpreted as its name to use for an OpenShift group", - "groupMembershipAttributes": "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", + "groupNameAttributes": "groupNameAttributes defines which attributes on an LDAP group entry will be interpreted as its name to use for an OpenShift group", + "groupMembershipAttributes": "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", "usersQuery": "AllUsersQuery holds the template for an LDAP query that returns user entries.", - "userUIDAttribute": "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", - "userNameAttributes": "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", - "tolerateMemberNotFoundErrors": "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.", - "tolerateMemberOutOfScopeErrors": "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.", + "userUIDAttribute": "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", + "userNameAttributes": "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", + "tolerateMemberNotFoundErrors": "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.", + "tolerateMemberOutOfScopeErrors": "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.", } func (RFC2307Config) SwaggerDoc() map[string]string { @@ -761,8 +761,8 @@ func (RFC2307Config) SwaggerDoc() map[string]string { var map_RegistryLocation = map[string]string{ "": "RegistryLocation contains a location of the registry specified by the registry domain name. The domain name might include wildcards, like '*' or '??'.", - "domainName": "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.", - "insecure": "Insecure indicates whether the registry is secure (https) or insecure (http) By default (if not specified) the registry is assumed as secure.", + "domainName": "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.", + "insecure": "insecure indicates whether the registry is secure (https) or insecure (http) By default (if not specified) the registry is assumed as secure.", } func (RegistryLocation) SwaggerDoc() map[string]string { @@ -771,8 +771,8 @@ func (RegistryLocation) SwaggerDoc() map[string]string { var map_RemoteConnectionInfo = map[string]string{ "": "RemoteConnectionInfo holds information necessary for establishing a remote connection", - "url": "URL is the remote URL to connect to", - "ca": "CA is the CA for verifying TLS connections", + "url": "url is the remote URL to connect to", + "ca": "ca is the CA for verifying TLS connections", } func (RemoteConnectionInfo) SwaggerDoc() map[string]string { @@ -781,11 +781,11 @@ func (RemoteConnectionInfo) SwaggerDoc() map[string]string { var map_RequestHeaderAuthenticationOptions = map[string]string{ "": "RequestHeaderAuthenticationOptions provides options for setting up a front proxy against the entire API instead of against the /oauth endpoint.", - "clientCA": "ClientCA is a file with the trusted signer certs. It is required.", - "clientCommonNames": "ClientCommonNames is a required list of common names to require a match from.", - "usernameHeaders": "UsernameHeaders is the list of headers to check for user information. First hit wins.", + "clientCA": "clientCA is a file with the trusted signer certs. It is required.", + "clientCommonNames": "clientCommonNames is a required list of common names to require a match from.", + "usernameHeaders": "usernameHeaders is the list of headers to check for user information. First hit wins.", "groupHeaders": "GroupNameHeader is the set of headers to check for group information. All are unioned.", - "extraHeaderPrefixes": "ExtraHeaderPrefixes is the set of request header prefixes to inspect for user extra. X-Remote-Extra- is suggested.", + "extraHeaderPrefixes": "extraHeaderPrefixes is the set of request header prefixes to inspect for user extra. X-Remote-Extra- is suggested.", } func (RequestHeaderAuthenticationOptions) SwaggerDoc() map[string]string { @@ -794,14 +794,14 @@ func (RequestHeaderAuthenticationOptions) SwaggerDoc() map[string]string { var map_RequestHeaderIdentityProvider = map[string]string{ "": "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.", - "loginURL": "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}", - "challengeURL": "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}", - "clientCA": "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.", - "clientCommonNames": "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.", - "headers": "Headers is the set of headers to check for identity information", - "preferredUsernameHeaders": "PreferredUsernameHeaders is the set of headers to check for the preferred username", - "nameHeaders": "NameHeaders is the set of headers to check for the display name", - "emailHeaders": "EmailHeaders is the set of headers to check for the email address", + "loginURL": "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}", + "challengeURL": "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}", + "clientCA": "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.", + "clientCommonNames": "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.", + "headers": "headers is the set of headers to check for identity information", + "preferredUsernameHeaders": "preferredUsernameHeaders is the set of headers to check for the preferred username", + "nameHeaders": "nameHeaders is the set of headers to check for the display name", + "emailHeaders": "emailHeaders is the set of headers to check for the email address", } func (RequestHeaderIdentityProvider) SwaggerDoc() map[string]string { @@ -810,7 +810,7 @@ func (RequestHeaderIdentityProvider) SwaggerDoc() map[string]string { var map_RoutingConfig = map[string]string{ "": "RoutingConfig holds the necessary configuration options for routing to subdomains", - "subdomain": "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.", + "subdomain": "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.", } func (RoutingConfig) SwaggerDoc() map[string]string { @@ -819,9 +819,9 @@ func (RoutingConfig) SwaggerDoc() map[string]string { var map_SecurityAllocator = map[string]string{ "": "SecurityAllocator controls the automatic allocation of UIDs and MCS labels to a project. If nil, allocation is disabled.", - "uidAllocatorRange": "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).", - "mcsAllocatorRange": "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", - "mcsLabelsPerProject": "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).", + "uidAllocatorRange": "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).", + "mcsAllocatorRange": "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", + "mcsLabelsPerProject": "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).", } func (SecurityAllocator) SwaggerDoc() map[string]string { @@ -830,11 +830,11 @@ func (SecurityAllocator) SwaggerDoc() map[string]string { var map_ServiceAccountConfig = map[string]string{ "": "ServiceAccountConfig holds the necessary configuration options for a service account", - "managedNames": "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.", - "limitSecretReferences": "LimitSecretReferences controls whether or not to allow a service account to reference any secret in a namespace without explicitly referencing them", - "privateKeyFile": "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.", - "publicKeyFiles": "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.", - "masterCA": "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.", + "managedNames": "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.", + "limitSecretReferences": "limitSecretReferences controls whether or not to allow a service account to reference any secret in a namespace without explicitly referencing them", + "privateKeyFile": "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.", + "publicKeyFiles": "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.", + "masterCA": "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.", } func (ServiceAccountConfig) SwaggerDoc() map[string]string { @@ -843,7 +843,7 @@ func (ServiceAccountConfig) SwaggerDoc() map[string]string { var map_ServiceServingCert = map[string]string{ "": "ServiceServingCert holds configuration for service serving cert signer which creates cert/key pairs for pods fulfilling a service to serve with.", - "signer": "Signer holds the signing information used to automatically sign serving certificates. If this value is nil, then certs are not signed automatically.", + "signer": "signer holds the signing information used to automatically sign serving certificates. If this value is nil, then certs are not signed automatically.", } func (ServiceServingCert) SwaggerDoc() map[string]string { @@ -852,12 +852,12 @@ func (ServiceServingCert) SwaggerDoc() map[string]string { var map_ServingInfo = map[string]string{ "": "ServingInfo holds information about serving web pages", - "bindAddress": "BindAddress is the ip:port to serve on", - "bindNetwork": "BindNetwork is the type of network to bind to - defaults to \"tcp4\", accepts \"tcp\", \"tcp4\", and \"tcp6\"", - "clientCA": "ClientCA is the certificate bundle for all the signers that you'll recognize for incoming client certificates", - "namedCertificates": "NamedCertificates is a list of certificates to use to secure requests to specific hostnames", - "minTLSVersion": "MinTLSVersion is the minimum TLS version supported. Values must match version names from https://golang.org/pkg/crypto/tls/#pkg-constants", - "cipherSuites": "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", + "bindAddress": "bindAddress is the ip:port to serve on", + "bindNetwork": "bindNetwork is the type of network to bind to - defaults to \"tcp4\", accepts \"tcp\", \"tcp4\", and \"tcp6\"", + "clientCA": "clientCA is the certificate bundle for all the signers that you'll recognize for incoming client certificates", + "namedCertificates": "namedCertificates is a list of certificates to use to secure requests to specific hostnames", + "minTLSVersion": "minTLSVersion is the minimum TLS version supported. Values must match version names from https://golang.org/pkg/crypto/tls/#pkg-constants", + "cipherSuites": "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", } func (ServingInfo) SwaggerDoc() map[string]string { @@ -866,9 +866,9 @@ func (ServingInfo) SwaggerDoc() map[string]string { var map_SessionConfig = map[string]string{ "": "SessionConfig specifies options for cookie-based sessions. Used by AuthRequestHandlerSession", - "sessionSecretsFile": "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", - "sessionMaxAgeSeconds": "SessionMaxAgeSeconds specifies how long created sessions last. Used by AuthRequestHandlerSession", - "sessionName": "SessionName is the cookie name used to store the session", + "sessionSecretsFile": "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", + "sessionMaxAgeSeconds": "sessionMaxAgeSeconds specifies how long created sessions last. Used by AuthRequestHandlerSession", + "sessionName": "sessionName is the cookie name used to store the session", } func (SessionConfig) SwaggerDoc() map[string]string { @@ -877,8 +877,8 @@ func (SessionConfig) SwaggerDoc() map[string]string { var map_SessionSecret = map[string]string{ "": "SessionSecret is a secret used to authenticate/decrypt cookie-based sessions", - "authentication": "Authentication is used to authenticate sessions using HMAC. Recommended to use a secret with 32 or 64 bytes.", - "encryption": "Encryption is used to encrypt sessions. Must be 16, 24, or 32 characters long, to select AES-128, AES-", + "authentication": "authentication is used to authenticate sessions using HMAC. Recommended to use a secret with 32 or 64 bytes.", + "encryption": "encryption is used to encrypt sessions. Must be 16, 24, or 32 characters long, to select AES-128, AES-", } func (SessionSecret) SwaggerDoc() map[string]string { @@ -887,7 +887,7 @@ func (SessionSecret) SwaggerDoc() map[string]string { var map_SessionSecrets = map[string]string{ "": "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.", - "secrets": "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.", + "secrets": "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.", } func (SessionSecrets) SwaggerDoc() map[string]string { @@ -913,10 +913,10 @@ func (StringSource) SwaggerDoc() map[string]string { var map_StringSourceSpec = map[string]string{ "": "StringSourceSpec specifies a string value, or external location", - "value": "Value specifies the cleartext value, or an encrypted value if keyFile is specified.", - "env": "Env specifies an envvar containing the cleartext value, or an encrypted value if the keyFile is specified.", - "file": "File references a file containing the cleartext value, or an encrypted value if a keyFile is specified.", - "keyFile": "KeyFile references a file containing the key to use to decrypt the value.", + "value": "value specifies the cleartext value, or an encrypted value if keyFile is specified.", + "env": "env specifies an envvar containing the cleartext value, or an encrypted value if the keyFile is specified.", + "file": "file references a file containing the cleartext value, or an encrypted value if a keyFile is specified.", + "keyFile": "keyFile references a file containing the key to use to decrypt the value.", } func (StringSourceSpec) SwaggerDoc() map[string]string { @@ -925,9 +925,9 @@ func (StringSourceSpec) SwaggerDoc() map[string]string { var map_TokenConfig = map[string]string{ "": "TokenConfig holds the necessary configuration options for authorization and access tokens", - "authorizeTokenMaxAgeSeconds": "AuthorizeTokenMaxAgeSeconds defines the maximum age of authorize tokens", - "accessTokenMaxAgeSeconds": "AccessTokenMaxAgeSeconds defines the maximum age of access tokens", - "accessTokenInactivityTimeoutSeconds": "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 overriden 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)", + "authorizeTokenMaxAgeSeconds": "authorizeTokenMaxAgeSeconds defines the maximum age of authorize tokens", + "accessTokenMaxAgeSeconds": "accessTokenMaxAgeSeconds defines the maximum age of access tokens", + "accessTokenInactivityTimeoutSeconds": "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 overriden 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)", } func (TokenConfig) SwaggerDoc() map[string]string { @@ -936,7 +936,7 @@ func (TokenConfig) SwaggerDoc() map[string]string { var map_UserAgentDenyRule = map[string]string{ "": "UserAgentDenyRule adds a rejection message that can be used to help a user figure out how to get an approved client", - "rejectionMessage": "RejectionMessage is the message shown when rejecting a client. If it is not a set, the default message is used.", + "rejectionMessage": "rejectionMessage is the message shown when rejecting a client. If it is not a set, the default message is used.", } func (UserAgentDenyRule) SwaggerDoc() map[string]string { @@ -946,7 +946,7 @@ func (UserAgentDenyRule) SwaggerDoc() map[string]string { var map_UserAgentMatchRule = map[string]string{ "": "UserAgentMatchRule describes how to match a given request based on User-Agent and HTTPVerb", "regex": "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", - "httpVerbs": "HTTPVerbs specifies which HTTP verbs should be matched. An empty list means \"match all verbs\".", + "httpVerbs": "httpVerbs specifies which HTTP verbs should be matched. An empty list means \"match all verbs\".", } func (UserAgentMatchRule) SwaggerDoc() map[string]string { @@ -957,7 +957,7 @@ var map_UserAgentMatchingConfig = map[string]string{ "": "UserAgentMatchingConfig controls how API calls from *voluntarily* identifying clients will be handled. THIS DOES NOT DEFEND AGAINST MALICIOUS CLIENTS!", "requiredClients": "If this list is non-empty, then a User-Agent must match one of the UserAgentRegexes to be allowed", "deniedClients": "If this list is non-empty, then a User-Agent must not match any of the UserAgentRegexes", - "defaultRejectionMessage": "DefaultRejectionMessage is the message shown when rejecting a client. If it is not a set, a generic message is given.", + "defaultRejectionMessage": "defaultRejectionMessage is the message shown when rejecting a client. If it is not a set, a generic message is given.", } func (UserAgentMatchingConfig) SwaggerDoc() map[string]string { @@ -966,8 +966,8 @@ func (UserAgentMatchingConfig) SwaggerDoc() map[string]string { var map_WebhookTokenAuthenticator = map[string]string{ "": "WebhookTokenAuthenticators holds the necessary configuation options for external token authenticators", - "configFile": "ConfigFile is a path to a Kubeconfig file with the webhook configuration", - "cacheTTL": "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", + "configFile": "configFile is a path to a Kubeconfig file with the webhook configuration", + "cacheTTL": "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", } func (WebhookTokenAuthenticator) SwaggerDoc() map[string]string { diff --git a/machine/v1/types_alibabaprovider.go b/machine/v1/types_alibabaprovider.go index 4b5c8d6efba..d1396fbfb2f 100644 --- a/machine/v1/types_alibabaprovider.go +++ b/machine/v1/types_alibabaprovider.go @@ -108,7 +108,7 @@ type AlibabaCloudMachineProviderConfig struct { // +optional DataDisks []DataDiskProperties `json:"dataDisk,omitempty"` - // SecurityGroups is a list of security group references to assign to the instance. + // 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. @@ -116,32 +116,32 @@ type AlibabaCloudMachineProviderConfig struct { // https://www.alibabacloud.com/help/en/doc-detail/25412.htm SecurityGroups []AlibabaResourceReference `json:"securityGroups,omitempty"` - // Bandwidth describes the internet bandwidth strategy for the instance + // bandwidth describes the internet bandwidth strategy for the instance // +optional Bandwidth BandwidthProperties `json:"bandwidth,omitempty"` - // SystemDisk holds the properties regarding the system disk for the instance + // systemDisk holds the properties regarding the system disk for the instance // +optional SystemDisk SystemDiskProperties `json:"systemDisk,omitempty"` - // VSwitch is a reference to the vswitch to use for this instance. + // 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. VSwitch AlibabaResourceReference `json:"vSwitch"` - // 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. + // 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. // +optional RAMRoleName string `json:"ramRoleName,omitempty"` - // ResourceGroup references the resource group to which to assign the instance. + // 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. ResourceGroup AlibabaResourceReference `json:"resourceGroup"` - // Tenancy specifies whether to create the instance on a dedicated host. + // tenancy specifies whether to create the instance on a dedicated host. // Valid values: // // default: creates the instance on a non-dedicated host. @@ -151,12 +151,12 @@ type AlibabaCloudMachineProviderConfig struct { // +optional Tenancy InstanceTenancy `json:"tenancy,omitempty"` - // UserDataSecret contains a local reference to a secret that contains the + // userDataSecret contains a local reference to a secret that contains the // UserData to apply to the instance // +optional UserDataSecret *corev1.LocalObjectReference `json:"userDataSecret,omitempty"` - // CredentialsSecret is a reference to the secret with alibabacloud credentials. Otherwise, defaults to permissions + // credentialsSecret is a reference to the secret with alibabacloud credentials. Otherwise, defaults to permissions // provided by attached RAM role where the actuator is running. // +optional CredentialsSecret *corev1.LocalObjectReference `json:"credentialsSecret,omitempty"` @@ -173,15 +173,15 @@ type AlibabaResourceReference struct { // type identifies the resource reference type for this entry. Type AlibabaResourceReferenceType `json:"type"` - // ID of resource + // id of resource // +optional ID *string `json:"id,omitempty"` - // Name of the resource + // name of the resource // +optional Name *string `json:"name,omitempty"` - // Tags is a set of metadata based upon ECS object tags used to identify a resource. + // 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. // +optional Tags *[]Tag `json:"tags,omitempty"` @@ -213,15 +213,15 @@ type AlibabaCloudMachineProviderStatus struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata,omitempty"` - // InstanceID is the instance ID of the machine created in alibabacloud + // instanceId is the instance ID of the machine created in alibabacloud // +optional InstanceID *string `json:"instanceId,omitempty"` - // InstanceState is the state of the alibabacloud instance for this machine + // instanceState is the state of the alibabacloud instance for this machine // +optional InstanceState *string `json:"instanceState,omitempty"` - // Conditions is a set of conditions associated with the Machine to indicate + // conditions is a set of conditions associated with the Machine to indicate // errors or other status // +optional Conditions []metav1.Condition `json:"conditions,omitempty"` @@ -229,7 +229,7 @@ type AlibabaCloudMachineProviderStatus struct { // SystemDiskProperties contains the information regarding the system disk including performance, size, name, and category type SystemDiskProperties struct { - // Category is the category of the system disk. + // 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. @@ -242,7 +242,7 @@ type SystemDiskProperties struct { // +optional Category string `json:"category,omitempty"` - // PerformanceLevel is the performance level of the ESSD used as the system disk. + // performanceLevel is the performance level of the ESSD used as the system disk. // Valid values: // // PL0: A single ESSD can deliver up to 10,000 random read/write IOPS. @@ -256,14 +256,14 @@ type SystemDiskProperties struct { // +optional PerformanceLevel string `json:"performanceLevel,omitempty"` - // 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 (-). + // 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 `""`. // +kubebuilder:validation:MaxLength=128 // +optional Name string `json:"name,omitempty"` - // Size is the size of the system disk. Unit: GiB. Valid values: 20 to 500. + // 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. @@ -357,7 +357,7 @@ type Tag struct { // Bandwidth describes the bandwidth strategy for the network of the instance type BandwidthProperties struct { - // InternetMaxBandwidthIn is the maximum inbound public bandwidth. Unit: Mbit/s. Valid values: + // 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. @@ -365,7 +365,7 @@ type BandwidthProperties struct { // +optional InternetMaxBandwidthIn int64 `json:"internetMaxBandwidthIn,omitempty"` - // InternetMaxBandwidthOut is the maximum outbound public bandwidth. Unit: Mbit/s. Valid values: 0 to 100. + // 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` diff --git a/machine/v1/types_aws.go b/machine/v1/types_aws.go index bc8a7efce99..c6e656e4483 100644 --- a/machine/v1/types_aws.go +++ b/machine/v1/types_aws.go @@ -8,17 +8,17 @@ package v1 // +kubebuilder:validation:XValidation:rule="has(self.type) && self.type == 'ARN' ? has(self.arn) : !has(self.arn)",message="arn is required when type is ARN, and forbidden otherwise" // +kubebuilder:validation:XValidation:rule="has(self.type) && self.type == 'Filters' ? has(self.filters) : !has(self.filters)",message="filters is required when type is Filters, and forbidden otherwise" type AWSResourceReference struct { - // Type determines how the reference will fetch the AWS resource. + // type determines how the reference will fetch the AWS resource. // +unionDiscriminator - // +kubebuilder:validation:Required + // +required Type AWSResourceReferenceType `json:"type"` - // ID of resource. + // id of resource. // +optional ID *string `json:"id,omitempty"` - // ARN of resource. + // arn of resource. // +optional ARN *string `json:"arn,omitempty"` - // Filters is a set of filters used to identify a resource. + // filters is a set of filters used to identify a resource. // +optional // +listType=atomic Filters *[]AWSResourceFilter `json:"filters,omitempty"` @@ -41,8 +41,8 @@ const ( // AWSResourceFilter is a filter used to identify an AWS resource type AWSResourceFilter struct { - // Name of the filter. Filter names are case-sensitive. - // +kubebuilder:validation:Required + // name of the filter. Filter names are case-sensitive. + // +required Name string `json:"name"` // Values includes one or more filter values. Filter values are case-sensitive. // +optional diff --git a/machine/v1/types_controlplanemachineset.go b/machine/v1/types_controlplanemachineset.go index 8ce5266e555..12b6e5184f4 100644 --- a/machine/v1/types_controlplanemachineset.go +++ b/machine/v1/types_controlplanemachineset.go @@ -58,7 +58,8 @@ type ControlPlaneMachineSetSpec struct { // +openshift:enable:FeatureGate=CPMSMachineNamePrefix // +optional MachineNamePrefix string `json:"machineNamePrefix,omitempty"` - // State defines whether the ControlPlaneMachineSet is Active or Inactive. + + // 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 @@ -71,7 +72,7 @@ type ControlPlaneMachineSetSpec struct { // +optional State ControlPlaneMachineSetState `json:"state,omitempty"` - // Replicas defines how many Control Plane Machines should be + // replicas defines how many Control Plane Machines should be // created by this ControlPlaneMachineSet. // This field is immutable and cannot be changed after cluster // installation. @@ -80,10 +81,10 @@ type ControlPlaneMachineSetSpec struct { // +kubebuilder:validation:Enum:=3;5 // +kubebuilder:default:=3 // +kubebuilder:validation:XValidation:rule="self == oldSelf",message="replicas is immutable" - // +kubebuilder:validation:Required + // +required Replicas *int32 `json:"replicas"` - // Strategy defines how the ControlPlaneMachineSet will update + // strategy defines how the ControlPlaneMachineSet will update // Machines when it detects a change to the ProviderSpec. // +kubebuilder:default:={type: RollingUpdate} // +optional @@ -94,12 +95,12 @@ type ControlPlaneMachineSetSpec struct { // It must match the template's labels. // This field is considered immutable after creation of the resource. // +kubebuilder:validation:XValidation:rule="self == oldSelf",message="selector is immutable" - // +kubebuilder:validation:Required + // +required Selector metav1.LabelSelector `json:"selector"` - // Template describes the Control Plane Machines that will be created + // template describes the Control Plane Machines that will be created // by this ControlPlaneMachineSet. - // +kubebuilder:validation:Required + // +required Template ControlPlaneMachineSetTemplate `json:"template"` } @@ -129,10 +130,10 @@ const ( // + future version of the Machine API Machine. // +kubebuilder:validation:XValidation:rule="has(self.machineType) && self.machineType == 'machines_v1beta1_machine_openshift_io' ? has(self.machines_v1beta1_machine_openshift_io) : !has(self.machines_v1beta1_machine_openshift_io)",message="machines_v1beta1_machine_openshift_io configuration is required when machineType is machines_v1beta1_machine_openshift_io, and forbidden otherwise" type ControlPlaneMachineSetTemplate struct { - // MachineType determines the type of Machines that should be managed by the ControlPlaneMachineSet. + // machineType determines the type of Machines that should be managed by the ControlPlaneMachineSet. // Currently, the only valid value is machines_v1beta1_machine_openshift_io. // +unionDiscriminator - // +kubebuilder:validation:Required + // +required MachineType ControlPlaneMachineSetMachineType `json:"machineType,omitempty"` // OpenShiftMachineV1Beta1Machine defines the template for creating Machines @@ -154,7 +155,7 @@ const ( // OpenShiftMachineV1Beta1MachineTemplate is a template for the ControlPlaneMachineSet to create // Machines from the v1beta1.machine.openshift.io API group. type OpenShiftMachineV1Beta1MachineTemplate struct { - // FailureDomains is the list of failure domains (sometimes called + // 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. @@ -165,16 +166,16 @@ type OpenShiftMachineV1Beta1MachineTemplate struct { // 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. - // +kubebuilder:validation:Required + // +required ObjectMeta ControlPlaneMachineSetTemplateObjectMeta `json:"metadata"` - // Spec contains the desired configuration of the Control Plane Machines. + // 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 overriden when the Machines // are created based on the FailureDomains field. - // +kubebuilder:validation:Required + // +required Spec machinev1beta1.MachineSpec `json:"spec"` } @@ -191,10 +192,10 @@ type ControlPlaneMachineSetTemplateObjectMeta struct { // +kubebuilder:validation:XValidation:rule="'machine.openshift.io/cluster-api-machine-role' in self && self['machine.openshift.io/cluster-api-machine-role'] == 'master'",message="label 'machine.openshift.io/cluster-api-machine-role' is required, and must have value 'master'" // +kubebuilder:validation:XValidation:rule="'machine.openshift.io/cluster-api-machine-type' in self && self['machine.openshift.io/cluster-api-machine-type'] == 'master'",message="label 'machine.openshift.io/cluster-api-machine-type' is required, and must have value 'master'" // +kubebuilder:validation:XValidation:rule="'machine.openshift.io/cluster-api-cluster' in self",message="label 'machine.openshift.io/cluster-api-cluster' is required" - // +kubebuilder:validation:Required + // +required Labels map[string]string `json:"labels"` - // Annotations is an unstructured key value map stored with a resource that may be + // 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 @@ -205,7 +206,7 @@ type ControlPlaneMachineSetTemplateObjectMeta struct { // ControlPlaneMachineSetStrategy defines the strategy for applying updates to the // Control Plane Machines managed by the ControlPlaneMachineSet. type ControlPlaneMachineSetStrategy struct { - // Type defines the type of update strategy that should be + // 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". @@ -256,23 +257,23 @@ const ( // +kubebuilder:validation:XValidation:rule="has(self.platform) && self.platform == 'VSphere' ? has(self.vsphere) : !has(self.vsphere)",message="vsphere configuration is required when platform is VSphere, and forbidden otherwise" // +kubebuilder:validation:XValidation:rule="has(self.platform) && self.platform == 'Nutanix' ? has(self.nutanix) : !has(self.nutanix)",message="nutanix configuration is required when platform is Nutanix, and forbidden otherwise" type FailureDomains struct { - // Platform identifies the platform for which the FailureDomain represents. + // platform identifies the platform for which the FailureDomain represents. // Currently supported values are AWS, Azure, GCP, OpenStack, VSphere and Nutanix. // +unionDiscriminator - // +kubebuilder:validation:Required + // +required Platform configv1.PlatformType `json:"platform"` - // AWS configures failure domain information for the AWS platform. + // aws configures failure domain information for the AWS platform. // +listType=atomic // +optional AWS *[]AWSFailureDomain `json:"aws,omitempty"` - // Azure configures failure domain information for the Azure platform. + // azure configures failure domain information for the Azure platform. // +listType=atomic // +optional Azure *[]AzureFailureDomain `json:"azure,omitempty"` - // GCP configures failure domain information for the GCP platform. + // gcp configures failure domain information for the GCP platform. // +listType=atomic // +optional GCP *[]GCPFailureDomain `json:"gcp,omitempty"` @@ -283,7 +284,7 @@ type FailureDomains struct { // +optional VSphere []VSphereFailureDomain `json:"vsphere,omitempty"` - // OpenStack configures failure domain information for the OpenStack platform. + // openstack configures failure domain information for the OpenStack platform. // +optional // // + --- @@ -305,19 +306,19 @@ type FailureDomains struct { // AWSFailureDomain configures failure domain information for the AWS platform. // +kubebuilder:validation:MinProperties:=1 type AWSFailureDomain struct { - // Subnet is a reference to the subnet to use for this instance. + // subnet is a reference to the subnet to use for this instance. // +optional Subnet *AWSResourceReference `json:"subnet,omitempty"` - // Placement configures the placement information for this instance. + // placement configures the placement information for this instance. // +optional Placement AWSFailureDomainPlacement `json:"placement,omitempty"` } // AWSFailureDomainPlacement configures the placement information for the AWSFailureDomain. type AWSFailureDomainPlacement struct { - // AvailabilityZone is the availability zone of the instance. - // +kubebuilder:validation:Required + // availabilityZone is the availability zone of the instance. + // +required AvailabilityZone string `json:"availabilityZone"` } @@ -325,7 +326,7 @@ type AWSFailureDomainPlacement struct { type AzureFailureDomain struct { // Availability Zone for the virtual machine. // If nil, the virtual machine should be deployed to no zone. - // +kubebuilder:validation:Required + // +required Zone string `json:"zone"` // subnet is the name of the network subnet in which the VM will be created. @@ -338,8 +339,8 @@ type AzureFailureDomain struct { // GCPFailureDomain configures failure domain information for the GCP platform type GCPFailureDomain struct { - // Zone is the zone in which the GCP machine provider will create the VM. - // +kubebuilder:validation:Required + // zone is the zone in which the GCP machine provider will create the VM. + // +required Zone string `json:"zone"` } @@ -349,7 +350,7 @@ type VSphereFailureDomain struct { // 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. - // +kubebuilder:validation:Required + // +required Name string `json:"name"` } @@ -383,7 +384,7 @@ type OpenStackFailureDomain struct { type NutanixFailureDomainReference struct { // 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. - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=64 // +kubebuilder:validation:Pattern=`[a-z0-9]([-a-z0-9]*[a-z0-9])?` @@ -416,7 +417,7 @@ type RootVolume struct { // + the control plane with a root volume. This is because the default volume type in Cinder is not guaranteed // + to be available, therefore we prefer the user to be explicit about the volume type to use. // + We apply the same logic in CPMS: if the failure domain specifies a root volume, we require the user to specify a volume type. - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=255 VolumeType string `json:"volumeType"` @@ -424,7 +425,7 @@ type RootVolume struct { // ControlPlaneMachineSetStatus represents the status of the ControlPlaneMachineSet CRD. type ControlPlaneMachineSetStatus struct { - // Conditions represents the observations of the ControlPlaneMachineSet's current state. + // conditions represents the observations of the ControlPlaneMachineSet's current state. // Known .status.conditions.type are: Available, Degraded and Progressing. // +patchMergeKey=type // +patchStrategy=merge @@ -433,27 +434,27 @@ type ControlPlaneMachineSetStatus struct { // +optional Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type"` - // ObservedGeneration is the most recent generation observed for this + // 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. // +optional ObservedGeneration int64 `json:"observedGeneration,omitempty"` - // Replicas is the number of Control Plane Machines created by the + // 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. // +optional Replicas int32 `json:"replicas,omitempty"` - // ReadyReplicas is the number of Control Plane Machines created by the + // 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. // +optional ReadyReplicas int32 `json:"readyReplicas,omitempty"` - // UpdatedReplicas is the number of non-terminated Control Plane Machines + // 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. @@ -464,7 +465,7 @@ type ControlPlaneMachineSetStatus struct { // +optional UpdatedReplicas int32 `json:"updatedReplicas,omitempty"` - // UnavailableReplicas is the number of Control Plane Machines that are + // 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. diff --git a/machine/v1/types_nutanixprovider.go b/machine/v1/types_nutanixprovider.go index e5e0ae83055..cc1a355b53b 100644 --- a/machine/v1/types_nutanixprovider.go +++ b/machine/v1/types_nutanixprovider.go @@ -23,40 +23,40 @@ type NutanixMachineProviderConfig struct { // 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. - // +kubebuilder:validation:Required + // +required Cluster NutanixResourceIdentifier `json:"cluster"` // 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. - // +kubebuilder:validation:Required + // +required Image NutanixResourceIdentifier `json:"image"` // 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. - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:MinItems=1 Subnets []NutanixResourceIdentifier `json:"subnets"` // vcpusPerSocket is the number of vCPUs per socket of the VM - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:Minimum=1 VCPUsPerSocket int32 `json:"vcpusPerSocket"` // vcpuSockets is the number of vCPU sockets of the VM - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:Minimum=1 VCPUSockets int32 `json:"vcpuSockets"` // memorySize is the memory size (in Quantity format) of the VM // The minimum memorySize is 2Gi bytes - // +kubebuilder:validation:Required + // +required MemorySize resource.Quantity `json:"memorySize"` // systemDiskSize is size (in Quantity format) of the system disk of the VM // The minimum systemDiskSize is 20Gi bytes - // +kubebuilder:validation:Required + // +required SystemDiskSize resource.Quantity `json:"systemDiskSize"` // bootType indicates the boot type (Legacy, UEFI or SecureBoot) the Machine's VM uses to boot. @@ -96,7 +96,7 @@ type NutanixMachineProviderConfig struct { // credentialsSecret is a local reference to a secret that contains the // credentials data to access Nutanix PC client - // +kubebuilder:validation:Required + // +required CredentialsSecret *corev1.LocalObjectReference `json:"credentialsSecret"` // failureDomain refers to the name of the FailureDomain with which this Machine is associated. @@ -113,13 +113,13 @@ type NutanixCategory struct { // key is the prism category key name // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=64 - // +kubebuilder:validation:Required + // +required Key string `json:"key"` // value is the prism category value associated with the key // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=64 - // +kubebuilder:validation:Required + // +required Value string `json:"value"` } @@ -151,9 +151,9 @@ const ( // NutanixResourceIdentifier holds the identity of a Nutanix PC resource (cluster, image, subnet, etc.) // +union type NutanixResourceIdentifier struct { - // Type is the identifier type to use for this resource. + // type is the identifier type to use for this resource. // +unionDiscriminator - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:Enum:=uuid;name Type NutanixIdentifierType `json:"type"` @@ -186,7 +186,7 @@ type NutanixGPU struct { // type is the identifier type of the GPU device. // Valid values are Name and DeviceID. // +unionDiscriminator - // +kubebuilder:validation:Required + // +required Type NutanixGPUIdentifierType `json:"type"` // deviceID is the GPU device ID with the integer value. @@ -219,7 +219,7 @@ type NutanixStorageResourceIdentifier struct { // type is the identifier type to use for this resource. // The valid value is "uuid". // +unionDiscriminator - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:Enum:=uuid Type NutanixIdentifierType `json:"type"` @@ -279,13 +279,13 @@ type NutanixVMDiskDeviceProperties struct { // deviceType specifies the disk device type. // The valid values are "Disk" and "CDRom", and the default is "Disk". // +kubebuilder:default=Disk - // +kubebuilder:validation:Required + // +required DeviceType NutanixDiskDeviceType `json:"deviceType"` // 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". - // +kubebuilder:validation:Required + // +required AdapterType NutanixDiskAdapterType `json:"adapterType,omitempty"` // deviceIndex is the index of the disk address. The valid values are non-negative integers, with the default value 0. @@ -295,7 +295,7 @@ type NutanixVMDiskDeviceProperties struct { // the deviceIndex should start from 1. // +kubebuilder:default=0 // +kubebuilder:validation:Minimum=0 - // +kubebuilder:validation:Required + // +required DeviceIndex int32 `json:"deviceIndex,omitempty"` } @@ -304,7 +304,7 @@ type NutanixVMDisk struct { // 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. - // +kubebuilder:validation:Required + // +required DiskSize resource.Quantity `json:"diskSize"` // deviceProperties are the properties of the disk device. diff --git a/machine/v1/types_powervsprovider.go b/machine/v1/types_powervsprovider.go index c131139c543..b676a8d5f75 100644 --- a/machine/v1/types_powervsprovider.go +++ b/machine/v1/types_powervsprovider.go @@ -142,18 +142,18 @@ type PowerVSMachineProviderConfig struct { // a validation error. // +union type PowerVSResource struct { - // Type identifies the resource type for this entry. + // type identifies the resource type for this entry. // Valid values are ID, Name and RegEx // +kubebuilder:validation:Enum:=ID;Name;RegEx // +optional Type PowerVSResourceType `json:"type,omitempty"` - // ID of resource + // id of resource // +optional ID *string `json:"id,omitempty"` - // Name of resource + // name of resource // +optional Name *string `json:"name,omitempty"` - // Regex to find resource + // regex to find resource // Regex contains the pattern to match to find a resource // +optional RegEx *string `json:"regex,omitempty"` @@ -200,7 +200,7 @@ type PowerVSMachineProviderStatus struct { // referenced secret inside the same namespace. // +structType=atomic type PowerVSSecretReference struct { - // Name of the secret. + // name of the secret. // +optional Name string `json:"name,omitempty"` } @@ -211,7 +211,7 @@ type LoadBalancerReference struct { // 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. - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:Pattern=`^([a-z]|[a-z][-a-z0-9]*[a-z0-9]|[0-9][-a-z0-9]*([a-z]|[-a-z][-a-z0-9]*[a-z0-9]))$` // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=63 @@ -221,7 +221,7 @@ type LoadBalancerReference struct { // More details about Application LoadBalancer // https://cloud.ibm.com/docs/vpc?topic=vpc-load-balancers-about&interface=ui // Supported values are Application. - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:Enum:="Application" Type IBMVPCLoadBalancerType `json:"type"` } diff --git a/machine/v1/zz_generated.crd-manifests/0000_10_control-plane-machine-set_01_controlplanemachinesets-CustomNoUpgrade.crd.yaml b/machine/v1/zz_generated.crd-manifests/0000_10_control-plane-machine-set_01_controlplanemachinesets-CustomNoUpgrade.crd.yaml index 45750709c71..333432c038a 100644 --- a/machine/v1/zz_generated.crd-manifests/0000_10_control-plane-machine-set_01_controlplanemachinesets-CustomNoUpgrade.crd.yaml +++ b/machine/v1/zz_generated.crd-manifests/0000_10_control-plane-machine-set_01_controlplanemachinesets-CustomNoUpgrade.crd.yaml @@ -98,7 +98,7 @@ spec: replicas: default: 3 description: |- - Replicas defines how many Control Plane Machines should be + replicas defines how many Control Plane Machines should be created by this ControlPlaneMachineSet. This field is immutable and cannot be changed after cluster installation. @@ -168,7 +168,7 @@ spec: state: default: Inactive description: |- - State defines whether the ControlPlaneMachineSet is Active or Inactive. + 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 @@ -186,13 +186,13 @@ spec: default: type: RollingUpdate description: |- - Strategy defines how the ControlPlaneMachineSet will update + strategy defines how the ControlPlaneMachineSet will update Machines when it detects a change to the ProviderSpec. properties: type: default: RollingUpdate description: |- - Type defines the type of update strategy that should be + 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". @@ -203,12 +203,12 @@ spec: type: object template: description: |- - Template describes the Control Plane Machines that will be created + template describes the Control Plane Machines that will be created by this ControlPlaneMachineSet. properties: machineType: description: |- - MachineType determines the type of Machines that should be managed by the ControlPlaneMachineSet. + machineType determines the type of Machines that should be managed by the ControlPlaneMachineSet. Currently, the only valid value is machines_v1beta1_machine_openshift_io. enum: - machines_v1beta1_machine_openshift_io @@ -220,14 +220,14 @@ spec: properties: failureDomains: description: |- - FailureDomains is the list of failure domains (sometimes called + 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. properties: aws: - description: AWS configures failure domain information + description: aws configures failure domain information for the AWS platform. items: description: AWSFailureDomain configures failure domain @@ -235,32 +235,32 @@ spec: minProperties: 1 properties: placement: - description: Placement configures the placement + description: placement configures the placement information for this instance. properties: availabilityZone: - description: AvailabilityZone is the availability + description: availabilityZone is the availability zone of the instance. type: string required: - availabilityZone type: object subnet: - description: Subnet is a reference to the subnet + description: subnet is a reference to the subnet to use for this instance. properties: arn: - description: ARN of resource. + description: arn of resource. type: string filters: - description: Filters is a set of filters used + description: filters is a set of filters used to identify a resource. items: description: AWSResourceFilter is a filter used to identify an AWS resource properties: name: - description: Name of the filter. Filter + description: name of the filter. Filter names are case-sensitive. type: string values: @@ -276,10 +276,10 @@ spec: type: array x-kubernetes-list-type: atomic id: - description: ID of resource. + description: id of resource. type: string type: - description: Type determines how the reference + description: type determines how the reference will fetch the AWS resource. enum: - ID @@ -306,7 +306,7 @@ spec: type: array x-kubernetes-list-type: atomic azure: - description: Azure configures failure domain information + description: azure configures failure domain information for the Azure platform. items: description: AzureFailureDomain configures failure domain @@ -330,14 +330,14 @@ spec: type: array x-kubernetes-list-type: atomic gcp: - description: GCP configures failure domain information + description: gcp configures failure domain information for the GCP platform. items: description: GCPFailureDomain configures failure domain information for the GCP platform properties: zone: - description: Zone is the zone in which the GCP machine + description: zone is the zone in which the GCP machine provider will create the VM. type: string required: @@ -368,7 +368,7 @@ spec: - name x-kubernetes-list-type: map openstack: - description: OpenStack configures failure domain information + description: openstack configures failure domain information for the OpenStack platform. items: description: OpenStackFailureDomain configures failure @@ -427,7 +427,7 @@ spec: x-kubernetes-list-type: atomic platform: description: |- - Platform identifies the platform for which the FailureDomain represents. + platform identifies the platform for which the FailureDomain represents. Currently supported values are AWS, Azure, GCP, OpenStack, VSphere and Nutanix. enum: - "" @@ -507,7 +507,7 @@ spec: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + 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 @@ -543,7 +543,7 @@ spec: type: object spec: description: |- - Spec contains the desired configuration of the Control Plane Machines. + 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 @@ -566,12 +566,12 @@ spec: type: string lifecycleHooks: description: |- - LifecycleHooks allow users to pause operations on the machine at + lifecycleHooks allow users to pause operations on the machine at certain predefined points within the machine lifecycle. properties: preDrain: description: |- - PreDrain hooks prevent the machine from being drained. + preDrain hooks prevent the machine from being drained. This also blocks further lifecycle events, such as termination. items: description: LifecycleHook represents a single instance @@ -579,7 +579,7 @@ spec: properties: name: description: |- - Name defines a unique name for the lifcycle hook. + 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. @@ -589,7 +589,7 @@ spec: type: string owner: description: |- - Owner defines the owner of the lifecycle hook. + 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) @@ -607,7 +607,7 @@ spec: x-kubernetes-list-type: map preTerminate: description: |- - PreTerminate hooks prevent the machine from being terminated. + preTerminate hooks prevent the machine from being terminated. PreTerminate hooks be actioned after the Machine has been drained. items: description: LifecycleHook represents a single instance @@ -615,7 +615,7 @@ spec: properties: name: description: |- - Name defines a unique name for the lifcycle hook. + 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. @@ -625,7 +625,7 @@ spec: type: string owner: description: |- - Owner defines the owner of the lifecycle hook. + 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) @@ -652,14 +652,14 @@ spec: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + 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 generateName: description: |- - GenerateName is an optional prefix, used by the server, to generate a unique + 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. @@ -686,7 +686,7 @@ spec: type: object name: description: |- - Name must be unique within a namespace. Is required when creating resources, although + 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. @@ -695,7 +695,7 @@ spec: type: string namespace: description: |- - Namespace defines the space within each name must be unique. An empty namespace is + 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. @@ -763,7 +763,7 @@ spec: type: object providerID: description: |- - ProviderID is the identification ID of the machine provided by the provider. + 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 @@ -775,12 +775,12 @@ spec: be interfacing with cluster-api as generic provider. type: string providerSpec: - description: ProviderSpec details Provider-specific configuration + description: providerSpec details Provider-specific configuration to use during node creation. properties: value: description: |- - Value is an inlined, serialized representation of the resource + 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. @@ -851,7 +851,7 @@ spec: properties: conditions: description: |- - Conditions represents the observations of the ControlPlaneMachineSet's current state. + conditions represents the observations of the ControlPlaneMachineSet's current state. Known .status.conditions.type are: Available, Degraded and Progressing. items: description: Condition contains details for one aspect of the current @@ -913,14 +913,14 @@ spec: x-kubernetes-list-type: map observedGeneration: description: |- - ObservedGeneration is the most recent generation observed for this + 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. format: int64 type: integer readyReplicas: description: |- - ReadyReplicas is the number of Control Plane Machines created by the + 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. @@ -928,7 +928,7 @@ spec: type: integer replicas: description: |- - Replicas is the number of Control Plane Machines created by the + 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. @@ -936,7 +936,7 @@ spec: type: integer unavailableReplicas: description: |- - UnavailableReplicas is the number of Control Plane Machines that are + 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. @@ -944,7 +944,7 @@ spec: type: integer updatedReplicas: description: |- - UpdatedReplicas is the number of non-terminated Control Plane Machines + 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. diff --git a/machine/v1/zz_generated.crd-manifests/0000_10_control-plane-machine-set_01_controlplanemachinesets-Default.crd.yaml b/machine/v1/zz_generated.crd-manifests/0000_10_control-plane-machine-set_01_controlplanemachinesets-Default.crd.yaml index 94e7a9e0fb7..14e225767c8 100644 --- a/machine/v1/zz_generated.crd-manifests/0000_10_control-plane-machine-set_01_controlplanemachinesets-Default.crd.yaml +++ b/machine/v1/zz_generated.crd-manifests/0000_10_control-plane-machine-set_01_controlplanemachinesets-Default.crd.yaml @@ -78,7 +78,7 @@ spec: replicas: default: 3 description: |- - Replicas defines how many Control Plane Machines should be + replicas defines how many Control Plane Machines should be created by this ControlPlaneMachineSet. This field is immutable and cannot be changed after cluster installation. @@ -148,7 +148,7 @@ spec: state: default: Inactive description: |- - State defines whether the ControlPlaneMachineSet is Active or Inactive. + 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 @@ -166,13 +166,13 @@ spec: default: type: RollingUpdate description: |- - Strategy defines how the ControlPlaneMachineSet will update + strategy defines how the ControlPlaneMachineSet will update Machines when it detects a change to the ProviderSpec. properties: type: default: RollingUpdate description: |- - Type defines the type of update strategy that should be + 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". @@ -183,12 +183,12 @@ spec: type: object template: description: |- - Template describes the Control Plane Machines that will be created + template describes the Control Plane Machines that will be created by this ControlPlaneMachineSet. properties: machineType: description: |- - MachineType determines the type of Machines that should be managed by the ControlPlaneMachineSet. + machineType determines the type of Machines that should be managed by the ControlPlaneMachineSet. Currently, the only valid value is machines_v1beta1_machine_openshift_io. enum: - machines_v1beta1_machine_openshift_io @@ -200,14 +200,14 @@ spec: properties: failureDomains: description: |- - FailureDomains is the list of failure domains (sometimes called + 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. properties: aws: - description: AWS configures failure domain information + description: aws configures failure domain information for the AWS platform. items: description: AWSFailureDomain configures failure domain @@ -215,32 +215,32 @@ spec: minProperties: 1 properties: placement: - description: Placement configures the placement + description: placement configures the placement information for this instance. properties: availabilityZone: - description: AvailabilityZone is the availability + description: availabilityZone is the availability zone of the instance. type: string required: - availabilityZone type: object subnet: - description: Subnet is a reference to the subnet + description: subnet is a reference to the subnet to use for this instance. properties: arn: - description: ARN of resource. + description: arn of resource. type: string filters: - description: Filters is a set of filters used + description: filters is a set of filters used to identify a resource. items: description: AWSResourceFilter is a filter used to identify an AWS resource properties: name: - description: Name of the filter. Filter + description: name of the filter. Filter names are case-sensitive. type: string values: @@ -256,10 +256,10 @@ spec: type: array x-kubernetes-list-type: atomic id: - description: ID of resource. + description: id of resource. type: string type: - description: Type determines how the reference + description: type determines how the reference will fetch the AWS resource. enum: - ID @@ -286,7 +286,7 @@ spec: type: array x-kubernetes-list-type: atomic azure: - description: Azure configures failure domain information + description: azure configures failure domain information for the Azure platform. items: description: AzureFailureDomain configures failure domain @@ -310,14 +310,14 @@ spec: type: array x-kubernetes-list-type: atomic gcp: - description: GCP configures failure domain information + description: gcp configures failure domain information for the GCP platform. items: description: GCPFailureDomain configures failure domain information for the GCP platform properties: zone: - description: Zone is the zone in which the GCP machine + description: zone is the zone in which the GCP machine provider will create the VM. type: string required: @@ -348,7 +348,7 @@ spec: - name x-kubernetes-list-type: map openstack: - description: OpenStack configures failure domain information + description: openstack configures failure domain information for the OpenStack platform. items: description: OpenStackFailureDomain configures failure @@ -407,7 +407,7 @@ spec: x-kubernetes-list-type: atomic platform: description: |- - Platform identifies the platform for which the FailureDomain represents. + platform identifies the platform for which the FailureDomain represents. Currently supported values are AWS, Azure, GCP, OpenStack, VSphere and Nutanix. enum: - "" @@ -487,7 +487,7 @@ spec: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + 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 @@ -523,7 +523,7 @@ spec: type: object spec: description: |- - Spec contains the desired configuration of the Control Plane Machines. + 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 @@ -532,12 +532,12 @@ spec: properties: lifecycleHooks: description: |- - LifecycleHooks allow users to pause operations on the machine at + lifecycleHooks allow users to pause operations on the machine at certain predefined points within the machine lifecycle. properties: preDrain: description: |- - PreDrain hooks prevent the machine from being drained. + preDrain hooks prevent the machine from being drained. This also blocks further lifecycle events, such as termination. items: description: LifecycleHook represents a single instance @@ -545,7 +545,7 @@ spec: properties: name: description: |- - Name defines a unique name for the lifcycle hook. + 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. @@ -555,7 +555,7 @@ spec: type: string owner: description: |- - Owner defines the owner of the lifecycle hook. + 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) @@ -573,7 +573,7 @@ spec: x-kubernetes-list-type: map preTerminate: description: |- - PreTerminate hooks prevent the machine from being terminated. + preTerminate hooks prevent the machine from being terminated. PreTerminate hooks be actioned after the Machine has been drained. items: description: LifecycleHook represents a single instance @@ -581,7 +581,7 @@ spec: properties: name: description: |- - Name defines a unique name for the lifcycle hook. + 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. @@ -591,7 +591,7 @@ spec: type: string owner: description: |- - Owner defines the owner of the lifecycle hook. + 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) @@ -618,14 +618,14 @@ spec: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + 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 generateName: description: |- - GenerateName is an optional prefix, used by the server, to generate a unique + 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. @@ -652,7 +652,7 @@ spec: type: object name: description: |- - Name must be unique within a namespace. Is required when creating resources, although + 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. @@ -661,7 +661,7 @@ spec: type: string namespace: description: |- - Namespace defines the space within each name must be unique. An empty namespace is + 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. @@ -729,7 +729,7 @@ spec: type: object providerID: description: |- - ProviderID is the identification ID of the machine provided by the provider. + 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 @@ -741,12 +741,12 @@ spec: be interfacing with cluster-api as generic provider. type: string providerSpec: - description: ProviderSpec details Provider-specific configuration + description: providerSpec details Provider-specific configuration to use during node creation. properties: value: description: |- - Value is an inlined, serialized representation of the resource + 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. @@ -817,7 +817,7 @@ spec: properties: conditions: description: |- - Conditions represents the observations of the ControlPlaneMachineSet's current state. + conditions represents the observations of the ControlPlaneMachineSet's current state. Known .status.conditions.type are: Available, Degraded and Progressing. items: description: Condition contains details for one aspect of the current @@ -879,14 +879,14 @@ spec: x-kubernetes-list-type: map observedGeneration: description: |- - ObservedGeneration is the most recent generation observed for this + 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. format: int64 type: integer readyReplicas: description: |- - ReadyReplicas is the number of Control Plane Machines created by the + 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. @@ -894,7 +894,7 @@ spec: type: integer replicas: description: |- - Replicas is the number of Control Plane Machines created by the + 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. @@ -902,7 +902,7 @@ spec: type: integer unavailableReplicas: description: |- - UnavailableReplicas is the number of Control Plane Machines that are + 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. @@ -910,7 +910,7 @@ spec: type: integer updatedReplicas: description: |- - UpdatedReplicas is the number of non-terminated Control Plane Machines + 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. diff --git a/machine/v1/zz_generated.crd-manifests/0000_10_control-plane-machine-set_01_controlplanemachinesets-DevPreviewNoUpgrade.crd.yaml b/machine/v1/zz_generated.crd-manifests/0000_10_control-plane-machine-set_01_controlplanemachinesets-DevPreviewNoUpgrade.crd.yaml index 1fb11eeb194..78ff1eca481 100644 --- a/machine/v1/zz_generated.crd-manifests/0000_10_control-plane-machine-set_01_controlplanemachinesets-DevPreviewNoUpgrade.crd.yaml +++ b/machine/v1/zz_generated.crd-manifests/0000_10_control-plane-machine-set_01_controlplanemachinesets-DevPreviewNoUpgrade.crd.yaml @@ -98,7 +98,7 @@ spec: replicas: default: 3 description: |- - Replicas defines how many Control Plane Machines should be + replicas defines how many Control Plane Machines should be created by this ControlPlaneMachineSet. This field is immutable and cannot be changed after cluster installation. @@ -168,7 +168,7 @@ spec: state: default: Inactive description: |- - State defines whether the ControlPlaneMachineSet is Active or Inactive. + 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 @@ -186,13 +186,13 @@ spec: default: type: RollingUpdate description: |- - Strategy defines how the ControlPlaneMachineSet will update + strategy defines how the ControlPlaneMachineSet will update Machines when it detects a change to the ProviderSpec. properties: type: default: RollingUpdate description: |- - Type defines the type of update strategy that should be + 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". @@ -203,12 +203,12 @@ spec: type: object template: description: |- - Template describes the Control Plane Machines that will be created + template describes the Control Plane Machines that will be created by this ControlPlaneMachineSet. properties: machineType: description: |- - MachineType determines the type of Machines that should be managed by the ControlPlaneMachineSet. + machineType determines the type of Machines that should be managed by the ControlPlaneMachineSet. Currently, the only valid value is machines_v1beta1_machine_openshift_io. enum: - machines_v1beta1_machine_openshift_io @@ -220,14 +220,14 @@ spec: properties: failureDomains: description: |- - FailureDomains is the list of failure domains (sometimes called + 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. properties: aws: - description: AWS configures failure domain information + description: aws configures failure domain information for the AWS platform. items: description: AWSFailureDomain configures failure domain @@ -235,32 +235,32 @@ spec: minProperties: 1 properties: placement: - description: Placement configures the placement + description: placement configures the placement information for this instance. properties: availabilityZone: - description: AvailabilityZone is the availability + description: availabilityZone is the availability zone of the instance. type: string required: - availabilityZone type: object subnet: - description: Subnet is a reference to the subnet + description: subnet is a reference to the subnet to use for this instance. properties: arn: - description: ARN of resource. + description: arn of resource. type: string filters: - description: Filters is a set of filters used + description: filters is a set of filters used to identify a resource. items: description: AWSResourceFilter is a filter used to identify an AWS resource properties: name: - description: Name of the filter. Filter + description: name of the filter. Filter names are case-sensitive. type: string values: @@ -276,10 +276,10 @@ spec: type: array x-kubernetes-list-type: atomic id: - description: ID of resource. + description: id of resource. type: string type: - description: Type determines how the reference + description: type determines how the reference will fetch the AWS resource. enum: - ID @@ -306,7 +306,7 @@ spec: type: array x-kubernetes-list-type: atomic azure: - description: Azure configures failure domain information + description: azure configures failure domain information for the Azure platform. items: description: AzureFailureDomain configures failure domain @@ -330,14 +330,14 @@ spec: type: array x-kubernetes-list-type: atomic gcp: - description: GCP configures failure domain information + description: gcp configures failure domain information for the GCP platform. items: description: GCPFailureDomain configures failure domain information for the GCP platform properties: zone: - description: Zone is the zone in which the GCP machine + description: zone is the zone in which the GCP machine provider will create the VM. type: string required: @@ -368,7 +368,7 @@ spec: - name x-kubernetes-list-type: map openstack: - description: OpenStack configures failure domain information + description: openstack configures failure domain information for the OpenStack platform. items: description: OpenStackFailureDomain configures failure @@ -427,7 +427,7 @@ spec: x-kubernetes-list-type: atomic platform: description: |- - Platform identifies the platform for which the FailureDomain represents. + platform identifies the platform for which the FailureDomain represents. Currently supported values are AWS, Azure, GCP, OpenStack, VSphere and Nutanix. enum: - "" @@ -507,7 +507,7 @@ spec: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + 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 @@ -543,7 +543,7 @@ spec: type: object spec: description: |- - Spec contains the desired configuration of the Control Plane Machines. + 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 @@ -552,12 +552,12 @@ spec: properties: lifecycleHooks: description: |- - LifecycleHooks allow users to pause operations on the machine at + lifecycleHooks allow users to pause operations on the machine at certain predefined points within the machine lifecycle. properties: preDrain: description: |- - PreDrain hooks prevent the machine from being drained. + preDrain hooks prevent the machine from being drained. This also blocks further lifecycle events, such as termination. items: description: LifecycleHook represents a single instance @@ -565,7 +565,7 @@ spec: properties: name: description: |- - Name defines a unique name for the lifcycle hook. + 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. @@ -575,7 +575,7 @@ spec: type: string owner: description: |- - Owner defines the owner of the lifecycle hook. + 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) @@ -593,7 +593,7 @@ spec: x-kubernetes-list-type: map preTerminate: description: |- - PreTerminate hooks prevent the machine from being terminated. + preTerminate hooks prevent the machine from being terminated. PreTerminate hooks be actioned after the Machine has been drained. items: description: LifecycleHook represents a single instance @@ -601,7 +601,7 @@ spec: properties: name: description: |- - Name defines a unique name for the lifcycle hook. + 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. @@ -611,7 +611,7 @@ spec: type: string owner: description: |- - Owner defines the owner of the lifecycle hook. + 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) @@ -638,14 +638,14 @@ spec: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + 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 generateName: description: |- - GenerateName is an optional prefix, used by the server, to generate a unique + 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. @@ -672,7 +672,7 @@ spec: type: object name: description: |- - Name must be unique within a namespace. Is required when creating resources, although + 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. @@ -681,7 +681,7 @@ spec: type: string namespace: description: |- - Namespace defines the space within each name must be unique. An empty namespace is + 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. @@ -749,7 +749,7 @@ spec: type: object providerID: description: |- - ProviderID is the identification ID of the machine provided by the provider. + 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 @@ -761,12 +761,12 @@ spec: be interfacing with cluster-api as generic provider. type: string providerSpec: - description: ProviderSpec details Provider-specific configuration + description: providerSpec details Provider-specific configuration to use during node creation. properties: value: description: |- - Value is an inlined, serialized representation of the resource + 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. @@ -837,7 +837,7 @@ spec: properties: conditions: description: |- - Conditions represents the observations of the ControlPlaneMachineSet's current state. + conditions represents the observations of the ControlPlaneMachineSet's current state. Known .status.conditions.type are: Available, Degraded and Progressing. items: description: Condition contains details for one aspect of the current @@ -899,14 +899,14 @@ spec: x-kubernetes-list-type: map observedGeneration: description: |- - ObservedGeneration is the most recent generation observed for this + 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. format: int64 type: integer readyReplicas: description: |- - ReadyReplicas is the number of Control Plane Machines created by the + 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. @@ -914,7 +914,7 @@ spec: type: integer replicas: description: |- - Replicas is the number of Control Plane Machines created by the + 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. @@ -922,7 +922,7 @@ spec: type: integer unavailableReplicas: description: |- - UnavailableReplicas is the number of Control Plane Machines that are + 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. @@ -930,7 +930,7 @@ spec: type: integer updatedReplicas: description: |- - UpdatedReplicas is the number of non-terminated Control Plane Machines + 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. diff --git a/machine/v1/zz_generated.crd-manifests/0000_10_control-plane-machine-set_01_controlplanemachinesets-TechPreviewNoUpgrade.crd.yaml b/machine/v1/zz_generated.crd-manifests/0000_10_control-plane-machine-set_01_controlplanemachinesets-TechPreviewNoUpgrade.crd.yaml index f3f3b6717b9..a72970ca0cd 100644 --- a/machine/v1/zz_generated.crd-manifests/0000_10_control-plane-machine-set_01_controlplanemachinesets-TechPreviewNoUpgrade.crd.yaml +++ b/machine/v1/zz_generated.crd-manifests/0000_10_control-plane-machine-set_01_controlplanemachinesets-TechPreviewNoUpgrade.crd.yaml @@ -98,7 +98,7 @@ spec: replicas: default: 3 description: |- - Replicas defines how many Control Plane Machines should be + replicas defines how many Control Plane Machines should be created by this ControlPlaneMachineSet. This field is immutable and cannot be changed after cluster installation. @@ -168,7 +168,7 @@ spec: state: default: Inactive description: |- - State defines whether the ControlPlaneMachineSet is Active or Inactive. + 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 @@ -186,13 +186,13 @@ spec: default: type: RollingUpdate description: |- - Strategy defines how the ControlPlaneMachineSet will update + strategy defines how the ControlPlaneMachineSet will update Machines when it detects a change to the ProviderSpec. properties: type: default: RollingUpdate description: |- - Type defines the type of update strategy that should be + 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". @@ -203,12 +203,12 @@ spec: type: object template: description: |- - Template describes the Control Plane Machines that will be created + template describes the Control Plane Machines that will be created by this ControlPlaneMachineSet. properties: machineType: description: |- - MachineType determines the type of Machines that should be managed by the ControlPlaneMachineSet. + machineType determines the type of Machines that should be managed by the ControlPlaneMachineSet. Currently, the only valid value is machines_v1beta1_machine_openshift_io. enum: - machines_v1beta1_machine_openshift_io @@ -220,14 +220,14 @@ spec: properties: failureDomains: description: |- - FailureDomains is the list of failure domains (sometimes called + 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. properties: aws: - description: AWS configures failure domain information + description: aws configures failure domain information for the AWS platform. items: description: AWSFailureDomain configures failure domain @@ -235,32 +235,32 @@ spec: minProperties: 1 properties: placement: - description: Placement configures the placement + description: placement configures the placement information for this instance. properties: availabilityZone: - description: AvailabilityZone is the availability + description: availabilityZone is the availability zone of the instance. type: string required: - availabilityZone type: object subnet: - description: Subnet is a reference to the subnet + description: subnet is a reference to the subnet to use for this instance. properties: arn: - description: ARN of resource. + description: arn of resource. type: string filters: - description: Filters is a set of filters used + description: filters is a set of filters used to identify a resource. items: description: AWSResourceFilter is a filter used to identify an AWS resource properties: name: - description: Name of the filter. Filter + description: name of the filter. Filter names are case-sensitive. type: string values: @@ -276,10 +276,10 @@ spec: type: array x-kubernetes-list-type: atomic id: - description: ID of resource. + description: id of resource. type: string type: - description: Type determines how the reference + description: type determines how the reference will fetch the AWS resource. enum: - ID @@ -306,7 +306,7 @@ spec: type: array x-kubernetes-list-type: atomic azure: - description: Azure configures failure domain information + description: azure configures failure domain information for the Azure platform. items: description: AzureFailureDomain configures failure domain @@ -330,14 +330,14 @@ spec: type: array x-kubernetes-list-type: atomic gcp: - description: GCP configures failure domain information + description: gcp configures failure domain information for the GCP platform. items: description: GCPFailureDomain configures failure domain information for the GCP platform properties: zone: - description: Zone is the zone in which the GCP machine + description: zone is the zone in which the GCP machine provider will create the VM. type: string required: @@ -368,7 +368,7 @@ spec: - name x-kubernetes-list-type: map openstack: - description: OpenStack configures failure domain information + description: openstack configures failure domain information for the OpenStack platform. items: description: OpenStackFailureDomain configures failure @@ -427,7 +427,7 @@ spec: x-kubernetes-list-type: atomic platform: description: |- - Platform identifies the platform for which the FailureDomain represents. + platform identifies the platform for which the FailureDomain represents. Currently supported values are AWS, Azure, GCP, OpenStack, VSphere and Nutanix. enum: - "" @@ -507,7 +507,7 @@ spec: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + 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 @@ -543,7 +543,7 @@ spec: type: object spec: description: |- - Spec contains the desired configuration of the Control Plane Machines. + 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 @@ -552,12 +552,12 @@ spec: properties: lifecycleHooks: description: |- - LifecycleHooks allow users to pause operations on the machine at + lifecycleHooks allow users to pause operations on the machine at certain predefined points within the machine lifecycle. properties: preDrain: description: |- - PreDrain hooks prevent the machine from being drained. + preDrain hooks prevent the machine from being drained. This also blocks further lifecycle events, such as termination. items: description: LifecycleHook represents a single instance @@ -565,7 +565,7 @@ spec: properties: name: description: |- - Name defines a unique name for the lifcycle hook. + 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. @@ -575,7 +575,7 @@ spec: type: string owner: description: |- - Owner defines the owner of the lifecycle hook. + 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) @@ -593,7 +593,7 @@ spec: x-kubernetes-list-type: map preTerminate: description: |- - PreTerminate hooks prevent the machine from being terminated. + preTerminate hooks prevent the machine from being terminated. PreTerminate hooks be actioned after the Machine has been drained. items: description: LifecycleHook represents a single instance @@ -601,7 +601,7 @@ spec: properties: name: description: |- - Name defines a unique name for the lifcycle hook. + 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. @@ -611,7 +611,7 @@ spec: type: string owner: description: |- - Owner defines the owner of the lifecycle hook. + 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) @@ -638,14 +638,14 @@ spec: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + 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 generateName: description: |- - GenerateName is an optional prefix, used by the server, to generate a unique + 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. @@ -672,7 +672,7 @@ spec: type: object name: description: |- - Name must be unique within a namespace. Is required when creating resources, although + 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. @@ -681,7 +681,7 @@ spec: type: string namespace: description: |- - Namespace defines the space within each name must be unique. An empty namespace is + 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. @@ -749,7 +749,7 @@ spec: type: object providerID: description: |- - ProviderID is the identification ID of the machine provided by the provider. + 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 @@ -761,12 +761,12 @@ spec: be interfacing with cluster-api as generic provider. type: string providerSpec: - description: ProviderSpec details Provider-specific configuration + description: providerSpec details Provider-specific configuration to use during node creation. properties: value: description: |- - Value is an inlined, serialized representation of the resource + 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. @@ -837,7 +837,7 @@ spec: properties: conditions: description: |- - Conditions represents the observations of the ControlPlaneMachineSet's current state. + conditions represents the observations of the ControlPlaneMachineSet's current state. Known .status.conditions.type are: Available, Degraded and Progressing. items: description: Condition contains details for one aspect of the current @@ -899,14 +899,14 @@ spec: x-kubernetes-list-type: map observedGeneration: description: |- - ObservedGeneration is the most recent generation observed for this + 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. format: int64 type: integer readyReplicas: description: |- - ReadyReplicas is the number of Control Plane Machines created by the + 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. @@ -914,7 +914,7 @@ spec: type: integer replicas: description: |- - Replicas is the number of Control Plane Machines created by the + 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. @@ -922,7 +922,7 @@ spec: type: integer unavailableReplicas: description: |- - UnavailableReplicas is the number of Control Plane Machines that are + 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. @@ -930,7 +930,7 @@ spec: type: integer updatedReplicas: description: |- - UpdatedReplicas is the number of non-terminated Control Plane Machines + 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. diff --git a/machine/v1/zz_generated.featuregated-crd-manifests/controlplanemachinesets.machine.openshift.io/AAA_ungated.yaml b/machine/v1/zz_generated.featuregated-crd-manifests/controlplanemachinesets.machine.openshift.io/AAA_ungated.yaml index bd6769ea2a3..4d1c1c1e43e 100644 --- a/machine/v1/zz_generated.featuregated-crd-manifests/controlplanemachinesets.machine.openshift.io/AAA_ungated.yaml +++ b/machine/v1/zz_generated.featuregated-crd-manifests/controlplanemachinesets.machine.openshift.io/AAA_ungated.yaml @@ -80,7 +80,7 @@ spec: replicas: default: 3 description: |- - Replicas defines how many Control Plane Machines should be + replicas defines how many Control Plane Machines should be created by this ControlPlaneMachineSet. This field is immutable and cannot be changed after cluster installation. @@ -150,7 +150,7 @@ spec: state: default: Inactive description: |- - State defines whether the ControlPlaneMachineSet is Active or Inactive. + 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 @@ -168,13 +168,13 @@ spec: default: type: RollingUpdate description: |- - Strategy defines how the ControlPlaneMachineSet will update + strategy defines how the ControlPlaneMachineSet will update Machines when it detects a change to the ProviderSpec. properties: type: default: RollingUpdate description: |- - Type defines the type of update strategy that should be + 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". @@ -185,12 +185,12 @@ spec: type: object template: description: |- - Template describes the Control Plane Machines that will be created + template describes the Control Plane Machines that will be created by this ControlPlaneMachineSet. properties: machineType: description: |- - MachineType determines the type of Machines that should be managed by the ControlPlaneMachineSet. + machineType determines the type of Machines that should be managed by the ControlPlaneMachineSet. Currently, the only valid value is machines_v1beta1_machine_openshift_io. enum: - machines_v1beta1_machine_openshift_io @@ -202,14 +202,14 @@ spec: properties: failureDomains: description: |- - FailureDomains is the list of failure domains (sometimes called + 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. properties: aws: - description: AWS configures failure domain information + description: aws configures failure domain information for the AWS platform. items: description: AWSFailureDomain configures failure domain @@ -217,32 +217,32 @@ spec: minProperties: 1 properties: placement: - description: Placement configures the placement + description: placement configures the placement information for this instance. properties: availabilityZone: - description: AvailabilityZone is the availability + description: availabilityZone is the availability zone of the instance. type: string required: - availabilityZone type: object subnet: - description: Subnet is a reference to the subnet + description: subnet is a reference to the subnet to use for this instance. properties: arn: - description: ARN of resource. + description: arn of resource. type: string filters: - description: Filters is a set of filters used + description: filters is a set of filters used to identify a resource. items: description: AWSResourceFilter is a filter used to identify an AWS resource properties: name: - description: Name of the filter. Filter + description: name of the filter. Filter names are case-sensitive. type: string values: @@ -258,10 +258,10 @@ spec: type: array x-kubernetes-list-type: atomic id: - description: ID of resource. + description: id of resource. type: string type: - description: Type determines how the reference + description: type determines how the reference will fetch the AWS resource. enum: - ID @@ -288,7 +288,7 @@ spec: type: array x-kubernetes-list-type: atomic azure: - description: Azure configures failure domain information + description: azure configures failure domain information for the Azure platform. items: description: AzureFailureDomain configures failure domain @@ -312,14 +312,14 @@ spec: type: array x-kubernetes-list-type: atomic gcp: - description: GCP configures failure domain information + description: gcp configures failure domain information for the GCP platform. items: description: GCPFailureDomain configures failure domain information for the GCP platform properties: zone: - description: Zone is the zone in which the GCP machine + description: zone is the zone in which the GCP machine provider will create the VM. type: string required: @@ -350,7 +350,7 @@ spec: - name x-kubernetes-list-type: map openstack: - description: OpenStack configures failure domain information + description: openstack configures failure domain information for the OpenStack platform. items: description: OpenStackFailureDomain configures failure @@ -409,7 +409,7 @@ spec: x-kubernetes-list-type: atomic platform: description: |- - Platform identifies the platform for which the FailureDomain represents. + platform identifies the platform for which the FailureDomain represents. Currently supported values are AWS, Azure, GCP, OpenStack, VSphere and Nutanix. enum: - "" @@ -489,7 +489,7 @@ spec: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + 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 @@ -525,7 +525,7 @@ spec: type: object spec: description: |- - Spec contains the desired configuration of the Control Plane Machines. + 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 @@ -534,12 +534,12 @@ spec: properties: lifecycleHooks: description: |- - LifecycleHooks allow users to pause operations on the machine at + lifecycleHooks allow users to pause operations on the machine at certain predefined points within the machine lifecycle. properties: preDrain: description: |- - PreDrain hooks prevent the machine from being drained. + preDrain hooks prevent the machine from being drained. This also blocks further lifecycle events, such as termination. items: description: LifecycleHook represents a single instance @@ -547,7 +547,7 @@ spec: properties: name: description: |- - Name defines a unique name for the lifcycle hook. + 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. @@ -557,7 +557,7 @@ spec: type: string owner: description: |- - Owner defines the owner of the lifecycle hook. + 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) @@ -575,7 +575,7 @@ spec: x-kubernetes-list-type: map preTerminate: description: |- - PreTerminate hooks prevent the machine from being terminated. + preTerminate hooks prevent the machine from being terminated. PreTerminate hooks be actioned after the Machine has been drained. items: description: LifecycleHook represents a single instance @@ -583,7 +583,7 @@ spec: properties: name: description: |- - Name defines a unique name for the lifcycle hook. + 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. @@ -593,7 +593,7 @@ spec: type: string owner: description: |- - Owner defines the owner of the lifecycle hook. + 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) @@ -620,14 +620,14 @@ spec: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + 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 generateName: description: |- - GenerateName is an optional prefix, used by the server, to generate a unique + 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. @@ -654,7 +654,7 @@ spec: type: object name: description: |- - Name must be unique within a namespace. Is required when creating resources, although + 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. @@ -663,7 +663,7 @@ spec: type: string namespace: description: |- - Namespace defines the space within each name must be unique. An empty namespace is + 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. @@ -731,7 +731,7 @@ spec: type: object providerID: description: |- - ProviderID is the identification ID of the machine provided by the provider. + 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 @@ -743,12 +743,12 @@ spec: be interfacing with cluster-api as generic provider. type: string providerSpec: - description: ProviderSpec details Provider-specific configuration + description: providerSpec details Provider-specific configuration to use during node creation. properties: value: description: |- - Value is an inlined, serialized representation of the resource + 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. @@ -819,7 +819,7 @@ spec: properties: conditions: description: |- - Conditions represents the observations of the ControlPlaneMachineSet's current state. + conditions represents the observations of the ControlPlaneMachineSet's current state. Known .status.conditions.type are: Available, Degraded and Progressing. items: description: Condition contains details for one aspect of the current @@ -881,14 +881,14 @@ spec: x-kubernetes-list-type: map observedGeneration: description: |- - ObservedGeneration is the most recent generation observed for this + 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. format: int64 type: integer readyReplicas: description: |- - ReadyReplicas is the number of Control Plane Machines created by the + 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. @@ -896,7 +896,7 @@ spec: type: integer replicas: description: |- - Replicas is the number of Control Plane Machines created by the + 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. @@ -904,7 +904,7 @@ spec: type: integer unavailableReplicas: description: |- - UnavailableReplicas is the number of Control Plane Machines that are + 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. @@ -912,7 +912,7 @@ spec: type: integer updatedReplicas: description: |- - UpdatedReplicas is the number of non-terminated Control Plane Machines + 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. diff --git a/machine/v1/zz_generated.featuregated-crd-manifests/controlplanemachinesets.machine.openshift.io/MachineAPIMigration.yaml b/machine/v1/zz_generated.featuregated-crd-manifests/controlplanemachinesets.machine.openshift.io/MachineAPIMigration.yaml index 2d0eb001515..df3a494a1ff 100644 --- a/machine/v1/zz_generated.featuregated-crd-manifests/controlplanemachinesets.machine.openshift.io/MachineAPIMigration.yaml +++ b/machine/v1/zz_generated.featuregated-crd-manifests/controlplanemachinesets.machine.openshift.io/MachineAPIMigration.yaml @@ -80,7 +80,7 @@ spec: replicas: default: 3 description: |- - Replicas defines how many Control Plane Machines should be + replicas defines how many Control Plane Machines should be created by this ControlPlaneMachineSet. This field is immutable and cannot be changed after cluster installation. @@ -150,7 +150,7 @@ spec: state: default: Inactive description: |- - State defines whether the ControlPlaneMachineSet is Active or Inactive. + 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 @@ -168,13 +168,13 @@ spec: default: type: RollingUpdate description: |- - Strategy defines how the ControlPlaneMachineSet will update + strategy defines how the ControlPlaneMachineSet will update Machines when it detects a change to the ProviderSpec. properties: type: default: RollingUpdate description: |- - Type defines the type of update strategy that should be + 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". @@ -185,12 +185,12 @@ spec: type: object template: description: |- - Template describes the Control Plane Machines that will be created + template describes the Control Plane Machines that will be created by this ControlPlaneMachineSet. properties: machineType: description: |- - MachineType determines the type of Machines that should be managed by the ControlPlaneMachineSet. + machineType determines the type of Machines that should be managed by the ControlPlaneMachineSet. Currently, the only valid value is machines_v1beta1_machine_openshift_io. enum: - machines_v1beta1_machine_openshift_io @@ -202,14 +202,14 @@ spec: properties: failureDomains: description: |- - FailureDomains is the list of failure domains (sometimes called + 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. properties: aws: - description: AWS configures failure domain information + description: aws configures failure domain information for the AWS platform. items: description: AWSFailureDomain configures failure domain @@ -217,32 +217,32 @@ spec: minProperties: 1 properties: placement: - description: Placement configures the placement + description: placement configures the placement information for this instance. properties: availabilityZone: - description: AvailabilityZone is the availability + description: availabilityZone is the availability zone of the instance. type: string required: - availabilityZone type: object subnet: - description: Subnet is a reference to the subnet + description: subnet is a reference to the subnet to use for this instance. properties: arn: - description: ARN of resource. + description: arn of resource. type: string filters: - description: Filters is a set of filters used + description: filters is a set of filters used to identify a resource. items: description: AWSResourceFilter is a filter used to identify an AWS resource properties: name: - description: Name of the filter. Filter + description: name of the filter. Filter names are case-sensitive. type: string values: @@ -258,10 +258,10 @@ spec: type: array x-kubernetes-list-type: atomic id: - description: ID of resource. + description: id of resource. type: string type: - description: Type determines how the reference + description: type determines how the reference will fetch the AWS resource. enum: - ID @@ -288,7 +288,7 @@ spec: type: array x-kubernetes-list-type: atomic azure: - description: Azure configures failure domain information + description: azure configures failure domain information for the Azure platform. items: description: AzureFailureDomain configures failure domain @@ -312,14 +312,14 @@ spec: type: array x-kubernetes-list-type: atomic gcp: - description: GCP configures failure domain information + description: gcp configures failure domain information for the GCP platform. items: description: GCPFailureDomain configures failure domain information for the GCP platform properties: zone: - description: Zone is the zone in which the GCP machine + description: zone is the zone in which the GCP machine provider will create the VM. type: string required: @@ -350,7 +350,7 @@ spec: - name x-kubernetes-list-type: map openstack: - description: OpenStack configures failure domain information + description: openstack configures failure domain information for the OpenStack platform. items: description: OpenStackFailureDomain configures failure @@ -409,7 +409,7 @@ spec: x-kubernetes-list-type: atomic platform: description: |- - Platform identifies the platform for which the FailureDomain represents. + platform identifies the platform for which the FailureDomain represents. Currently supported values are AWS, Azure, GCP, OpenStack, VSphere and Nutanix. enum: - "" @@ -489,7 +489,7 @@ spec: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + 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 @@ -525,7 +525,7 @@ spec: type: object spec: description: |- - Spec contains the desired configuration of the Control Plane Machines. + 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 @@ -548,12 +548,12 @@ spec: type: string lifecycleHooks: description: |- - LifecycleHooks allow users to pause operations on the machine at + lifecycleHooks allow users to pause operations on the machine at certain predefined points within the machine lifecycle. properties: preDrain: description: |- - PreDrain hooks prevent the machine from being drained. + preDrain hooks prevent the machine from being drained. This also blocks further lifecycle events, such as termination. items: description: LifecycleHook represents a single instance @@ -561,7 +561,7 @@ spec: properties: name: description: |- - Name defines a unique name for the lifcycle hook. + 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. @@ -571,7 +571,7 @@ spec: type: string owner: description: |- - Owner defines the owner of the lifecycle hook. + 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) @@ -589,7 +589,7 @@ spec: x-kubernetes-list-type: map preTerminate: description: |- - PreTerminate hooks prevent the machine from being terminated. + preTerminate hooks prevent the machine from being terminated. PreTerminate hooks be actioned after the Machine has been drained. items: description: LifecycleHook represents a single instance @@ -597,7 +597,7 @@ spec: properties: name: description: |- - Name defines a unique name for the lifcycle hook. + 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. @@ -607,7 +607,7 @@ spec: type: string owner: description: |- - Owner defines the owner of the lifecycle hook. + 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) @@ -634,14 +634,14 @@ spec: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + 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 generateName: description: |- - GenerateName is an optional prefix, used by the server, to generate a unique + 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. @@ -668,7 +668,7 @@ spec: type: object name: description: |- - Name must be unique within a namespace. Is required when creating resources, although + 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. @@ -677,7 +677,7 @@ spec: type: string namespace: description: |- - Namespace defines the space within each name must be unique. An empty namespace is + 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. @@ -745,7 +745,7 @@ spec: type: object providerID: description: |- - ProviderID is the identification ID of the machine provided by the provider. + 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 @@ -757,12 +757,12 @@ spec: be interfacing with cluster-api as generic provider. type: string providerSpec: - description: ProviderSpec details Provider-specific configuration + description: providerSpec details Provider-specific configuration to use during node creation. properties: value: description: |- - Value is an inlined, serialized representation of the resource + 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. @@ -833,7 +833,7 @@ spec: properties: conditions: description: |- - Conditions represents the observations of the ControlPlaneMachineSet's current state. + conditions represents the observations of the ControlPlaneMachineSet's current state. Known .status.conditions.type are: Available, Degraded and Progressing. items: description: Condition contains details for one aspect of the current @@ -895,14 +895,14 @@ spec: x-kubernetes-list-type: map observedGeneration: description: |- - ObservedGeneration is the most recent generation observed for this + 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. format: int64 type: integer readyReplicas: description: |- - ReadyReplicas is the number of Control Plane Machines created by the + 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. @@ -910,7 +910,7 @@ spec: type: integer replicas: description: |- - Replicas is the number of Control Plane Machines created by the + 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. @@ -918,7 +918,7 @@ spec: type: integer unavailableReplicas: description: |- - UnavailableReplicas is the number of Control Plane Machines that are + 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. @@ -926,7 +926,7 @@ spec: type: integer updatedReplicas: description: |- - UpdatedReplicas is the number of non-terminated Control Plane Machines + 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. diff --git a/machine/v1/zz_generated.swagger_doc_generated.go b/machine/v1/zz_generated.swagger_doc_generated.go index 5e460391065..00c9a461f66 100644 --- a/machine/v1/zz_generated.swagger_doc_generated.go +++ b/machine/v1/zz_generated.swagger_doc_generated.go @@ -20,15 +20,15 @@ var map_AlibabaCloudMachineProviderConfig = map[string]string{ "zoneId": "The ID of the zone in which to create the instance. You can call the DescribeZones operation to query the most recent region list.", "imageId": "The ID of the image used to create the instance.", "dataDisk": "DataDisks holds information regarding the extra disks attached to the instance", - "securityGroups": "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", - "bandwidth": "Bandwidth describes the internet bandwidth strategy for the instance", - "systemDisk": "SystemDisk holds the properties regarding the system disk for the instance", - "vSwitch": "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.", - "ramRoleName": "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.", - "resourceGroup": "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.", - "tenancy": "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`.", - "userDataSecret": "UserDataSecret contains a local reference to a secret that contains the UserData to apply to the instance", - "credentialsSecret": "CredentialsSecret is a reference to the secret with alibabacloud credentials. Otherwise, defaults to permissions provided by attached RAM role where the actuator is running.", + "securityGroups": "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", + "bandwidth": "bandwidth describes the internet bandwidth strategy for the instance", + "systemDisk": "systemDisk holds the properties regarding the system disk for the instance", + "vSwitch": "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.", + "ramRoleName": "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.", + "resourceGroup": "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.", + "tenancy": "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`.", + "userDataSecret": "userDataSecret contains a local reference to a secret that contains the UserData to apply to the instance", + "credentialsSecret": "credentialsSecret is a reference to the secret with alibabacloud credentials. Otherwise, defaults to permissions provided by attached RAM role where the actuator is running.", "tag": "Tags are the set of metadata to add to an instance.", } @@ -48,9 +48,9 @@ func (AlibabaCloudMachineProviderConfigList) SwaggerDoc() map[string]string { var map_AlibabaCloudMachineProviderStatus = map[string]string{ "": "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).", "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "instanceId": "InstanceID is the instance ID of the machine created in alibabacloud", - "instanceState": "InstanceState is the state of the alibabacloud instance for this machine", - "conditions": "Conditions is a set of conditions associated with the Machine to indicate errors or other status", + "instanceId": "instanceId is the instance ID of the machine created in alibabacloud", + "instanceState": "instanceState is the state of the alibabacloud instance for this machine", + "conditions": "conditions is a set of conditions associated with the Machine to indicate errors or other status", } func (AlibabaCloudMachineProviderStatus) SwaggerDoc() map[string]string { @@ -60,9 +60,9 @@ func (AlibabaCloudMachineProviderStatus) SwaggerDoc() map[string]string { var map_AlibabaResourceReference = map[string]string{ "": "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": "type identifies the resource reference type for this entry.", - "id": "ID of resource", - "name": "Name of the resource", - "tags": "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.", + "id": "id of resource", + "name": "name of the resource", + "tags": "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.", } func (AlibabaResourceReference) SwaggerDoc() map[string]string { @@ -71,8 +71,8 @@ func (AlibabaResourceReference) SwaggerDoc() map[string]string { var map_BandwidthProperties = map[string]string{ "": "Bandwidth describes the bandwidth strategy for the network of the instance", - "internetMaxBandwidthIn": "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.", - "internetMaxBandwidthOut": "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`", + "internetMaxBandwidthIn": "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.", + "internetMaxBandwidthOut": "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`", } func (BandwidthProperties) SwaggerDoc() map[string]string { @@ -97,10 +97,10 @@ func (DataDiskProperties) SwaggerDoc() map[string]string { var map_SystemDiskProperties = map[string]string{ "": "SystemDiskProperties contains the information regarding the system disk including performance, size, name, and category", - "category": "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`.", - "performanceLevel": "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.", - "name": "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 `\"\"`.", - "size": "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.", + "category": "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`.", + "performanceLevel": "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.", + "name": "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 `\"\"`.", + "size": "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.", } func (SystemDiskProperties) SwaggerDoc() map[string]string { @@ -119,7 +119,7 @@ func (Tag) SwaggerDoc() map[string]string { var map_AWSResourceFilter = map[string]string{ "": "AWSResourceFilter is a filter used to identify an AWS resource", - "name": "Name of the filter. Filter names are case-sensitive.", + "name": "name of the filter. Filter names are case-sensitive.", "values": "Values includes one or more filter values. Filter values are case-sensitive.", } @@ -129,10 +129,10 @@ func (AWSResourceFilter) SwaggerDoc() map[string]string { var map_AWSResourceReference = map[string]string{ "": "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": "Type determines how the reference will fetch the AWS resource.", - "id": "ID of resource.", - "arn": "ARN of resource.", - "filters": "Filters is a set of filters used to identify a resource.", + "type": "type determines how the reference will fetch the AWS resource.", + "id": "id of resource.", + "arn": "arn of resource.", + "filters": "filters is a set of filters used to identify a resource.", } func (AWSResourceReference) SwaggerDoc() map[string]string { @@ -141,8 +141,8 @@ func (AWSResourceReference) SwaggerDoc() map[string]string { var map_AWSFailureDomain = map[string]string{ "": "AWSFailureDomain configures failure domain information for the AWS platform.", - "subnet": "Subnet is a reference to the subnet to use for this instance.", - "placement": "Placement configures the placement information for this instance.", + "subnet": "subnet is a reference to the subnet to use for this instance.", + "placement": "placement configures the placement information for this instance.", } func (AWSFailureDomain) SwaggerDoc() map[string]string { @@ -151,7 +151,7 @@ func (AWSFailureDomain) SwaggerDoc() map[string]string { var map_AWSFailureDomainPlacement = map[string]string{ "": "AWSFailureDomainPlacement configures the placement information for the AWSFailureDomain.", - "availabilityZone": "AvailabilityZone is the availability zone of the instance.", + "availabilityZone": "availabilityZone is the availability zone of the instance.", } func (AWSFailureDomainPlacement) SwaggerDoc() map[string]string { @@ -189,11 +189,11 @@ func (ControlPlaneMachineSetList) SwaggerDoc() map[string]string { var map_ControlPlaneMachineSetSpec = map[string]string{ "": "ControlPlaneMachineSet represents the configuration of the ControlPlaneMachineSet.", "machineNamePrefix": "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, '-', or '.', and must start and end with an alphanumeric character. 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", - "state": "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.", - "replicas": "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.", - "strategy": "Strategy defines how the ControlPlaneMachineSet will update Machines when it detects a change to the ProviderSpec.", + "state": "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.", + "replicas": "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.", + "strategy": "strategy defines how the ControlPlaneMachineSet will update Machines when it detects a change to the ProviderSpec.", "selector": "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.", - "template": "Template describes the Control Plane Machines that will be created by this ControlPlaneMachineSet.", + "template": "template describes the Control Plane Machines that will be created by this ControlPlaneMachineSet.", } func (ControlPlaneMachineSetSpec) SwaggerDoc() map[string]string { @@ -202,12 +202,12 @@ func (ControlPlaneMachineSetSpec) SwaggerDoc() map[string]string { var map_ControlPlaneMachineSetStatus = map[string]string{ "": "ControlPlaneMachineSetStatus represents the status of the ControlPlaneMachineSet CRD.", - "conditions": "Conditions represents the observations of the ControlPlaneMachineSet's current state. Known .status.conditions.type are: Available, Degraded and Progressing.", - "observedGeneration": "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.", - "replicas": "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.", - "readyReplicas": "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.", - "updatedReplicas": "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.", - "unavailableReplicas": "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.", + "conditions": "conditions represents the observations of the ControlPlaneMachineSet's current state. Known .status.conditions.type are: Available, Degraded and Progressing.", + "observedGeneration": "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.", + "replicas": "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.", + "readyReplicas": "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.", + "updatedReplicas": "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.", + "unavailableReplicas": "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.", } func (ControlPlaneMachineSetStatus) SwaggerDoc() map[string]string { @@ -216,7 +216,7 @@ func (ControlPlaneMachineSetStatus) SwaggerDoc() map[string]string { var map_ControlPlaneMachineSetStrategy = map[string]string{ "": "ControlPlaneMachineSetStrategy defines the strategy for applying updates to the Control Plane Machines managed by the ControlPlaneMachineSet.", - "type": "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": "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\".", } func (ControlPlaneMachineSetStrategy) SwaggerDoc() map[string]string { @@ -225,7 +225,7 @@ func (ControlPlaneMachineSetStrategy) SwaggerDoc() map[string]string { var map_ControlPlaneMachineSetTemplate = map[string]string{ "": "ControlPlaneMachineSetTemplate is a template used by the ControlPlaneMachineSet to create the Machines that it will manage in the future. ", - "machineType": "MachineType determines the type of Machines that should be managed by the ControlPlaneMachineSet. Currently, the only valid value is machines_v1beta1_machine_openshift_io.", + "machineType": "machineType determines the type of Machines that should be managed by the ControlPlaneMachineSet. Currently, the only valid value is machines_v1beta1_machine_openshift_io.", "machines_v1beta1_machine_openshift_io": "OpenShiftMachineV1Beta1Machine defines the template for creating Machines from the v1beta1.machine.openshift.io API group.", } @@ -236,7 +236,7 @@ func (ControlPlaneMachineSetTemplate) SwaggerDoc() map[string]string { var map_ControlPlaneMachineSetTemplateObjectMeta = map[string]string{ "": "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.", "labels": "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'.", - "annotations": "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", + "annotations": "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", } func (ControlPlaneMachineSetTemplateObjectMeta) SwaggerDoc() map[string]string { @@ -245,12 +245,12 @@ func (ControlPlaneMachineSetTemplateObjectMeta) SwaggerDoc() map[string]string { var map_FailureDomains = map[string]string{ "": "FailureDomain represents the different configurations required to spread Machines across failure domains on different platforms.", - "platform": "Platform identifies the platform for which the FailureDomain represents. Currently supported values are AWS, Azure, GCP, OpenStack, VSphere and Nutanix.", - "aws": "AWS configures failure domain information for the AWS platform.", - "azure": "Azure configures failure domain information for the Azure platform.", - "gcp": "GCP configures failure domain information for the GCP platform.", + "platform": "platform identifies the platform for which the FailureDomain represents. Currently supported values are AWS, Azure, GCP, OpenStack, VSphere and Nutanix.", + "aws": "aws configures failure domain information for the AWS platform.", + "azure": "azure configures failure domain information for the Azure platform.", + "gcp": "gcp configures failure domain information for the GCP platform.", "vsphere": "vsphere configures failure domain information for the VSphere platform.", - "openstack": "OpenStack configures failure domain information for the OpenStack platform.", + "openstack": "openstack configures failure domain information for the OpenStack platform.", "nutanix": "nutanix configures failure domain information for the Nutanix platform.", } @@ -260,7 +260,7 @@ func (FailureDomains) SwaggerDoc() map[string]string { var map_GCPFailureDomain = map[string]string{ "": "GCPFailureDomain configures failure domain information for the GCP platform", - "zone": "Zone is the zone in which the GCP machine provider will create the VM.", + "zone": "zone is the zone in which the GCP machine provider will create the VM.", } func (GCPFailureDomain) SwaggerDoc() map[string]string { @@ -278,9 +278,9 @@ func (NutanixFailureDomainReference) SwaggerDoc() map[string]string { var map_OpenShiftMachineV1Beta1MachineTemplate = map[string]string{ "": "OpenShiftMachineV1Beta1MachineTemplate is a template for the ControlPlaneMachineSet to create Machines from the v1beta1.machine.openshift.io API group.", - "failureDomains": "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.", + "failureDomains": "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.", "metadata": "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.", - "spec": "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 overriden when the Machines are created based on the FailureDomains field.", + "spec": "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 overriden when the Machines are created based on the FailureDomains field.", } func (OpenShiftMachineV1Beta1MachineTemplate) SwaggerDoc() map[string]string { @@ -373,7 +373,7 @@ func (NutanixMachineProviderStatus) SwaggerDoc() map[string]string { var map_NutanixResourceIdentifier = map[string]string{ "": "NutanixResourceIdentifier holds the identity of a Nutanix PC resource (cluster, image, subnet, etc.)", - "type": "Type is the identifier type to use for this resource.", + "type": "type is the identifier type to use for this resource.", "uuid": "uuid is the UUID of the resource in the PC.", "name": "name is the resource name in the PC", } @@ -468,10 +468,10 @@ func (PowerVSMachineProviderStatus) SwaggerDoc() map[string]string { var map_PowerVSResource = map[string]string{ "": "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": "Type identifies the resource type for this entry. Valid values are ID, Name and RegEx", - "id": "ID of resource", - "name": "Name of resource", - "regex": "Regex to find resource Regex contains the pattern to match to find a resource", + "type": "type identifies the resource type for this entry. Valid values are ID, Name and RegEx", + "id": "id of resource", + "name": "name of resource", + "regex": "regex to find resource Regex contains the pattern to match to find a resource", } func (PowerVSResource) SwaggerDoc() map[string]string { @@ -480,7 +480,7 @@ func (PowerVSResource) SwaggerDoc() map[string]string { var map_PowerVSSecretReference = map[string]string{ "": "PowerVSSecretReference contains enough information to locate the referenced secret inside the same namespace.", - "name": "Name of the secret.", + "name": "name of the secret.", } func (PowerVSSecretReference) SwaggerDoc() map[string]string { diff --git a/machine/v1alpha1/types_openstack.go b/machine/v1alpha1/types_openstack.go index da5fbc51524..89b55c7b41f 100644 --- a/machine/v1alpha1/types_openstack.go +++ b/machine/v1alpha1/types_openstack.go @@ -166,9 +166,9 @@ type NetworkParam struct { Filter Filter `json:"filter,omitempty"` // Subnet within a network to use Subnets []SubnetParam `json:"subnets,omitempty"` - // NoAllowedAddressPairs disables creation of allowed address pairs for the network ports + // noAllowedAddressPairs disables creation of allowed address pairs for the network ports NoAllowedAddressPairs bool `json:"noAllowedAddressPairs,omitempty"` - // PortTags allows users to specify a list of tags to add to ports created in a given network + // portTags allows users to specify a list of tags to add to ports created in a given network PortTags []string `json:"portTags,omitempty"` // The virtual network interface card (vNIC) type that is bound to the // neutron port. @@ -177,7 +177,7 @@ type NetworkParam struct { // host to pass and receive virtual network interface (VIF) port-specific // information to the plug-in. Profile map[string]string `json:"profile,omitempty"` - // PortSecurity optionally enables or disables security on ports managed by OpenStack + // portSecurity optionally enables or disables security on ports managed by OpenStack PortSecurity *bool `json:"portSecurity,omitempty"` } @@ -229,10 +229,10 @@ type SubnetParam struct { // Filters for optional network query Filter SubnetFilter `json:"filter,omitempty"` - // PortTags are tags that are added to ports created on this subnet + // portTags are tags that are added to ports created on this subnet PortTags []string `json:"portTags,omitempty"` - // PortSecurity optionally enables or disables security on ports managed by OpenStack + // portSecurity optionally enables or disables security on ports managed by OpenStack PortSecurity *bool `json:"portSecurity,omitempty"` } @@ -379,7 +379,7 @@ type RootVolume struct { type BlockDeviceStorage struct { // type is the type of block device to create. // This can be either "Volume" or "Local". - // +kubebuilder:validation:Required + // +required // +unionDiscriminator Type BlockDeviceType `json:"type"` @@ -414,16 +414,16 @@ type AdditionalBlockDevice struct { // 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. - // +kubebuilder:validation:Required + // +required Name string `json:"name"` // sizeGiB is the size of the block device in gibibytes (GiB). - // +kubebuilder:validation:Required + // +required SizeGiB int `json:"sizeGiB"` // storage specifies the storage type of the block device and // additional storage options. - // +kubebuilder:validation:Required + // +required Storage BlockDeviceStorage `json:"storage"` } diff --git a/machine/v1alpha1/zz_generated.swagger_doc_generated.go b/machine/v1alpha1/zz_generated.swagger_doc_generated.go index c8094eb2698..2818d17bb86 100644 --- a/machine/v1alpha1/zz_generated.swagger_doc_generated.go +++ b/machine/v1alpha1/zz_generated.swagger_doc_generated.go @@ -79,11 +79,11 @@ var map_NetworkParam = map[string]string{ "fixedIp": "A fixed IPv4 address for the NIC.", "filter": "Filters for optional network query", "subnets": "Subnet within a network to use", - "noAllowedAddressPairs": "NoAllowedAddressPairs disables creation of allowed address pairs for the network ports", - "portTags": "PortTags allows users to specify a list of tags to add to ports created in a given network", + "noAllowedAddressPairs": "noAllowedAddressPairs disables creation of allowed address pairs for the network ports", + "portTags": "portTags allows users to specify a list of tags to add to ports created in a given network", "vnicType": "The virtual network interface card (vNIC) type that is bound to the neutron port.", "profile": "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.", - "portSecurity": "PortSecurity optionally enables or disables security on ports managed by OpenStack", + "portSecurity": "portSecurity optionally enables or disables security on ports managed by OpenStack", } func (NetworkParam) SwaggerDoc() map[string]string { @@ -217,8 +217,8 @@ func (SubnetFilter) SwaggerDoc() map[string]string { var map_SubnetParam = map[string]string{ "uuid": "The UUID of the network. Required if you omit the port attribute.", "filter": "Filters for optional network query", - "portTags": "PortTags are tags that are added to ports created on this subnet", - "portSecurity": "PortSecurity optionally enables or disables security on ports managed by OpenStack", + "portTags": "portTags are tags that are added to ports created on this subnet", + "portSecurity": "portSecurity optionally enables or disables security on ports managed by OpenStack", } func (SubnetParam) SwaggerDoc() map[string]string { diff --git a/machine/v1beta1/types_awsprovider.go b/machine/v1beta1/types_awsprovider.go index b2c66b7072b..b34a87886d4 100644 --- a/machine/v1beta1/types_awsprovider.go +++ b/machine/v1beta1/types_awsprovider.go @@ -13,38 +13,38 @@ type AWSMachineProviderConfig struct { metav1.TypeMeta `json:",inline"` // +optional metav1.ObjectMeta `json:"metadata,omitempty"` - // AMI is the reference to the AMI from which to create the machine instance. + // ami is the reference to the AMI from which to create the machine instance. AMI AWSResourceReference `json:"ami"` - // InstanceType is the type of instance to create. Example: m4.xlarge + // instanceType is the type of instance to create. Example: m4.xlarge InstanceType string `json:"instanceType"` - // Tags is the set of tags to add to apply to an instance, in addition to the ones + // 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. // +optional Tags []TagSpecification `json:"tags,omitempty"` - // IAMInstanceProfile is a reference to an IAM role to assign to the instance + // iamInstanceProfile is a reference to an IAM role to assign to the instance // +optional IAMInstanceProfile *AWSResourceReference `json:"iamInstanceProfile,omitempty"` - // UserDataSecret contains a local reference to a secret that contains the + // userDataSecret contains a local reference to a secret that contains the // UserData to apply to the instance // +optional UserDataSecret *corev1.LocalObjectReference `json:"userDataSecret,omitempty"` - // CredentialsSecret is a reference to the secret with AWS credentials. Otherwise, defaults to permissions + // credentialsSecret is a reference to the secret with AWS credentials. Otherwise, defaults to permissions // provided by attached IAM role where the actuator is running. // +optional CredentialsSecret *corev1.LocalObjectReference `json:"credentialsSecret,omitempty"` - // KeyName is the name of the KeyPair to use for SSH + // keyName is the name of the KeyPair to use for SSH // +optional KeyName *string `json:"keyName,omitempty"` - // DeviceIndex is the index of the device on the instance for the network interface attachment. + // deviceIndex is the index of the device on the instance for the network interface attachment. // Defaults to 0. DeviceIndex int64 `json:"deviceIndex"` - // PublicIP specifies whether the instance should get a public IP. If not present, + // publicIp specifies whether the instance should get a public IP. If not present, // it should use the default of its subnet. // +optional PublicIP *bool `json:"publicIp,omitempty"` - // NetworkInterfaceType specifies the type of network interface to be used for the primary + // 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. @@ -54,32 +54,32 @@ type AWSMachineProviderConfig struct { // +kubebuilder:validation:Enum:="ENA";"EFA" // +optional NetworkInterfaceType AWSNetworkInterfaceType `json:"networkInterfaceType,omitempty"` - // SecurityGroups is an array of references to security groups that should be applied to the + // securityGroups is an array of references to security groups that should be applied to the // instance. // +optional SecurityGroups []AWSResourceReference `json:"securityGroups,omitempty"` - // Subnet is a reference to the subnet to use for this instance + // subnet is a reference to the subnet to use for this instance Subnet AWSResourceReference `json:"subnet"` - // Placement specifies where to create the instance in AWS + // placement specifies where to create the instance in AWS Placement Placement `json:"placement"` - // LoadBalancers is the set of load balancers to which the new instance + // loadBalancers is the set of load balancers to which the new instance // should be added once it is created. // +optional LoadBalancers []LoadBalancerReference `json:"loadBalancers,omitempty"` - // BlockDevices is the set of block device mapping associated to this instance, + // 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 // +optional BlockDevices []BlockDeviceMappingSpec `json:"blockDevices,omitempty"` - // SpotMarketOptions allows users to configure instances to be run using AWS Spot instances. + // spotMarketOptions allows users to configure instances to be run using AWS Spot instances. // +optional SpotMarketOptions *SpotMarketOptions `json:"spotMarketOptions,omitempty"` - // MetadataServiceOptions allows users to configure instance metadata service interaction options. + // 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 // +optional MetadataServiceOptions MetadataServiceOptions `json:"metadataServiceOptions,omitempty"` - // PlacementGroupName specifies the name of the placement group in which to launch the instance. + // 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. // +optional @@ -194,7 +194,7 @@ const ( // MetadataServiceOptions defines the options available to a user when configuring // Instance Metadata Service (IMDS) Options. type MetadataServiceOptions struct { - // Authentication determines whether or not the host requires the use of authentication when interacting with the metadata service. + // 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. @@ -209,26 +209,26 @@ type MetadataServiceOptions struct { // Only one of ID, ARN or Filters may be specified. Specifying more than one will result in // a validation error. type AWSResourceReference struct { - // ID of resource + // id of resource // +optional ID *string `json:"id,omitempty"` - // ARN of resource + // arn of resource // +optional ARN *string `json:"arn,omitempty"` - // Filters is a set of filters used to identify a resource + // filters is a set of filters used to identify a resource // +optional Filters []Filter `json:"filters,omitempty"` } // Placement indicates where to create the instance in AWS type Placement struct { - // Region is the region to use to create the instance + // region is the region to use to create the instance // +optional Region string `json:"region,omitempty"` - // AvailabilityZone is the availability zone of the instance + // availabilityZone is the availability zone of the instance // +optional AvailabilityZone string `json:"availabilityZone,omitempty"` - // Tenancy indicates if instance should run on shared or single-tenant hardware. There are + // tenancy indicates if instance should run on shared or single-tenant hardware. There are // supported 3 options: default, dedicated and host. // +optional Tenancy InstanceTenancy `json:"tenancy,omitempty"` @@ -236,18 +236,18 @@ type Placement struct { // Filter is a filter used to identify an AWS resource type Filter struct { - // Name of the filter. Filter names are case-sensitive. + // name of the filter. Filter names are case-sensitive. Name string `json:"name"` - // Values includes one or more filter values. Filter values are case-sensitive. + // values includes one or more filter values. Filter values are case-sensitive. // +optional Values []string `json:"values,omitempty"` } // TagSpecification is the name/value pair for a tag type TagSpecification struct { - // Name of the tag + // name of the tag Name string `json:"name"` - // Value of the tag + // value of the tag Value string `json:"value"` } @@ -309,13 +309,13 @@ const ( // +openshift:compatibility-gen:level=2 type AWSMachineProviderStatus struct { metav1.TypeMeta `json:",inline"` - // InstanceID is the instance ID of the machine created in AWS + // instanceId is the instance ID of the machine created in AWS // +optional InstanceID *string `json:"instanceId,omitempty"` - // InstanceState is the state of the AWS instance for this machine + // instanceState is the state of the AWS instance for this machine // +optional InstanceState *string `json:"instanceState,omitempty"` - // Conditions is a set of conditions associated with the Machine to indicate + // conditions is a set of conditions associated with the Machine to indicate // errors or other status // +optional Conditions []metav1.Condition `json:"conditions,omitempty"` diff --git a/machine/v1beta1/types_azureprovider.go b/machine/v1beta1/types_azureprovider.go index 00a9497fd36..496071fe18c 100644 --- a/machine/v1beta1/types_azureprovider.go +++ b/machine/v1beta1/types_azureprovider.go @@ -39,32 +39,32 @@ type AzureMachineProviderSpec struct { metav1.TypeMeta `json:",inline"` // +optional metav1.ObjectMeta `json:"metadata,omitempty"` - // UserDataSecret contains a local reference to a secret that contains the + // userDataSecret contains a local reference to a secret that contains the // UserData to apply to the instance // +optional UserDataSecret *corev1.SecretReference `json:"userDataSecret,omitempty"` - // CredentialsSecret is a reference to the secret with Azure credentials. + // credentialsSecret is a reference to the secret with Azure credentials. // +optional CredentialsSecret *corev1.SecretReference `json:"credentialsSecret,omitempty"` - // Location is the region to use to create the instance + // location is the region to use to create the instance // +optional Location string `json:"location,omitempty"` - // VMSize is the size of the VM to create. + // vmSize is the size of the VM to create. // +optional VMSize string `json:"vmSize,omitempty"` - // Image is the OS image to use to create the instance. + // image is the OS image to use to create the instance. Image Image `json:"image"` - // OSDisk represents the parameters for creating the OS disk. + // osDisk represents the parameters for creating the OS disk. OSDisk OSDisk `json:"osDisk"` // DataDisk specifies the parameters that are used to add one or more data disks to the machine. // +optional DataDisks []DataDisk `json:"dataDisks,omitempty"` - // SSHPublicKey is the public key to use to SSH to the virtual machine. + // sshPublicKey is the public key to use to SSH to the virtual machine. // +optional SSHPublicKey string `json:"sshPublicKey,omitempty"` - // PublicIP if true a public IP will be used + // publicIP if true a public IP will be used PublicIP bool `json:"publicIP"` - // Tags is a list of tags to apply to the machine. + // tags is a list of tags to apply to the machine. // +optional Tags map[string]string `json:"tags,omitempty"` // Network Security Group that needs to be attached to the machine's interface. @@ -75,40 +75,40 @@ type AzureMachineProviderSpec struct { // No application security groups will be attached if zero-length. // +optional ApplicationSecurityGroups []string `json:"applicationSecurityGroups,omitempty"` - // Subnet to use for this instance + // subnet to use for this instance Subnet string `json:"subnet"` - // PublicLoadBalancer to use for this instance + // publicLoadBalancer to use for this instance // +optional PublicLoadBalancer string `json:"publicLoadBalancer,omitempty"` // InternalLoadBalancerName to use for this instance // +optional InternalLoadBalancer string `json:"internalLoadBalancer,omitempty"` - // NatRule to set inbound NAT rule of the load balancer + // natRule to set inbound NAT rule of the load balancer // +optional NatRule *int64 `json:"natRule,omitempty"` - // ManagedIdentity to set managed identity name + // managedIdentity to set managed identity name // +optional ManagedIdentity string `json:"managedIdentity,omitempty"` - // Vnet to set virtual network name + // vnet to set virtual network name // +optional Vnet string `json:"vnet,omitempty"` // Availability Zone for the virtual machine. // If nil, the virtual machine should be deployed to no zone // +optional Zone string `json:"zone,omitempty"` - // NetworkResourceGroup is the resource group for the virtual machine's network + // networkResourceGroup is the resource group for the virtual machine's network // +optional NetworkResourceGroup string `json:"networkResourceGroup,omitempty"` - // ResourceGroup is the resource group for the virtual machine + // resourceGroup is the resource group for the virtual machine // +optional ResourceGroup string `json:"resourceGroup,omitempty"` - // SpotVMOptions allows the ability to specify the Machine should use a Spot VM + // spotVMOptions allows the ability to specify the Machine should use a Spot VM // +optional SpotVMOptions *SpotVMOptions `json:"spotVMOptions,omitempty"` - // SecurityProfile specifies the Security profile settings for a virtual machine. + // securityProfile specifies the Security profile settings for a virtual machine. // +optional SecurityProfile *SecurityProfile `json:"securityProfile,omitempty"` - // UltraSSDCapability enables or disables Azure UltraSSD capability for a virtual machine. + // 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: @@ -130,16 +130,16 @@ type AzureMachineProviderSpec struct { // +kubebuilder:validation:Enum:="Enabled";"Disabled" // +optional UltraSSDCapability AzureUltraSSDCapabilityState `json:"ultraSSDCapability,omitempty"` - // AcceleratedNetworking enables or disables Azure accelerated networking feature. + // 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. // +optional AcceleratedNetworking bool `json:"acceleratedNetworking,omitempty"` - // AvailabilitySet specifies the availability set to use for this instance. + // availabilitySet specifies the availability set to use for this instance. // Availability set should be precreated, before using this field. // +optional AvailabilitySet string `json:"availabilitySet,omitempty"` - // Diagnostics configures the diagnostics settings for the virtual machine. + // 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. @@ -156,7 +156,7 @@ type AzureMachineProviderSpec struct { // SpotVMOptions defines the options relevant to running the Machine on Spot VMs type SpotVMOptions struct { - // MaxPrice defines the maximum price the user is willing to pay for Spot VM instances + // maxPrice defines the maximum price the user is willing to pay for Spot VM instances // +optional MaxPrice *resource.Quantity `json:"maxPrice,omitempty"` } @@ -177,13 +177,13 @@ type AzureDiagnostics struct { // This is useful for debugging software based launch issues. // +union type AzureBootDiagnostics struct { - // StorageAccountType determines if the storage account for storing the diagnostics data + // storageAccountType determines if the storage account for storing the diagnostics data // should be provisioned by Azure (AzureManaged) or by the customer (CustomerManaged). - // +kubebuilder:validation:Required + // +required // +unionDiscriminator StorageAccountType AzureBootDiagnosticsStorageAccountType `json:"storageAccountType"` - // CustomerManaged provides reference to the customer manager storage account. + // customerManaged provides reference to the customer manager storage account. // +optional CustomerManaged *AzureCustomerManagedBootDiagnostics `json:"customerManaged,omitempty"` } @@ -191,12 +191,12 @@ type AzureBootDiagnostics struct { // AzureCustomerManagedBootDiagnostics provides reference to a customer managed // storage account. type AzureCustomerManagedBootDiagnostics struct { - // StorageAccountURI is the URI of the customer managed storage account. + // 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. - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:Pattern=`^https://` // +kubebuilder:validation:MaxLength=1024 StorageAccountURI string `json:"storageAccountURI"` @@ -225,13 +225,13 @@ type AzureMachineProviderStatus struct { metav1.TypeMeta `json:",inline"` // +optional metav1.ObjectMeta `json:"metadata,omitempty"` - // VMID is the ID of the virtual machine created in Azure. + // vmId is the ID of the virtual machine created in Azure. // +optional VMID *string `json:"vmId,omitempty"` - // VMState is the provisioning state of the Azure virtual machine. + // vmState is the provisioning state of the Azure virtual machine. // +optional VMState *AzureVMState `json:"vmState,omitempty"` - // Conditions is a set of conditions associated with the Machine to indicate + // conditions is a set of conditions associated with the Machine to indicate // errors or other status. // +optional Conditions []metav1.Condition `json:"conditions,omitempty"` @@ -274,23 +274,23 @@ const ( // Image is a mirror of azure sdk compute.ImageReference type Image struct { - // Publisher is the name of the organization that created the image + // publisher is the name of the organization that created the image Publisher string `json:"publisher"` - // Offer specifies the name of a group of related images created by the publisher. + // offer specifies the name of a group of related images created by the publisher. // For example, UbuntuServer, WindowsServer Offer string `json:"offer"` - // SKU specifies an instance of an offer, such as a major release of a distribution. + // sku specifies an instance of an offer, such as a major release of a distribution. // For example, 18.04-LTS, 2019-Datacenter SKU string `json:"sku"` - // Version specifies the version of an image sku. The allowed formats + // 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. Version string `json:"version"` - // ResourceID specifies an image to use by ID + // resourceID specifies an image to use by ID ResourceID string `json:"resourceID"` - // Type identifies the source of the image and related information, such as purchase plans. + // 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. @@ -313,16 +313,16 @@ const ( ) type OSDisk struct { - // OSType is the operating system type of the OS disk. Possible values include "Linux" and "Windows". + // osType is the operating system type of the OS disk. Possible values include "Linux" and "Windows". OSType string `json:"osType"` - // ManagedDisk specifies the Managed Disk parameters for the OS disk. + // managedDisk specifies the Managed Disk parameters for the OS disk. ManagedDisk OSDiskManagedDiskParameters `json:"managedDisk"` - // DiskSizeGB is the size in GB to assign to the data disk. + // diskSizeGB is the size in GB to assign to the data disk. DiskSizeGB int32 `json:"diskSizeGB"` - // DiskSettings describe ephemeral disk settings for the os disk. + // diskSettings describe ephemeral disk settings for the os disk. // +optional DiskSettings DiskSettings `json:"diskSettings,omitempty"` - // CachingType specifies the caching requirements. + // 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`. @@ -342,43 +342,43 @@ type OSDisk struct { // 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 DataDisk struct { - // NameSuffix is the suffix to be appended to the machine name to generate the disk name. + // 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. // +kubebuilder:validation:Pattern:=`^[a-zA-Z0-9](?:[\w\.-]*[a-zA-Z0-9])?$` // +kubebuilder:validation:MaxLength:=78 - // +kubebuilder:validation:Required + // +required NameSuffix string `json:"nameSuffix"` - // DiskSizeGB is the size in GB to assign to the data disk. + // diskSizeGB is the size in GB to assign to the data disk. // +kubebuilder:validation:Minimum=4 - // +kubebuilder:validation:Required + // +required DiskSizeGB int32 `json:"diskSizeGB"` - // ManagedDisk specifies the Managed Disk parameters for the data disk. + // 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". // +optional ManagedDisk DataDiskManagedDiskParameters `json:"managedDisk,omitempty"` - // Lun Specifies the logical unit number of the data disk. + // 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. // +kubebuilder:validation:Minimum=0 // +kubebuilder:validation:Maximum=63 - // +kubebuilder:validation:Required + // +required Lun int32 `json:"lun,omitempty"` - // CachingType specifies the caching requirements. + // 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. // +optional // +kubebuilder:validation:Enum=None;ReadOnly;ReadWrite CachingType CachingTypeOption `json:"cachingType,omitempty"` - // DeletionPolicy specifies the data disk deletion policy upon Machine deletion. + // 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. // +kubebuilder:validation:Enum=Delete;Detach - // +kubebuilder:validation:Required + // +required DeletionPolicy DiskDeletionPolicyType `json:"deletionPolicy"` } @@ -514,7 +514,7 @@ type SecuritySettings struct { // 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. // +kubebuilder:validation:Enum=ConfidentialVM;TrustedLaunch - // +kubebuilder:validation:Required + // +required // +unionDiscriminator SecurityType SecurityTypes `json:"securityType,omitempty"` // confidentialVM specifies the security configuration of the virtual machine. @@ -532,14 +532,14 @@ type SecuritySettings struct { // ConfidentialVM defines the UEFI settings for the virtual machine. type ConfidentialVM struct { // uefiSettings specifies the security settings like secure boot and vTPM used while creating the virtual machine. - // +kubebuilder:validation:Required + // +required UEFISettings UEFISettings `json:"uefiSettings,omitempty"` } // TrustedLaunch defines the UEFI settings for the virtual machine. type TrustedLaunch struct { // uefiSettings specifies the security settings like secure boot and vTPM used while creating the virtual machine. - // +kubebuilder:validation:Required + // +required UEFISettings UEFISettings `json:"uefiSettings,omitempty"` } diff --git a/machine/v1beta1/types_gcpprovider.go b/machine/v1beta1/types_gcpprovider.go index b5bb506192f..1d9b40fb1ea 100644 --- a/machine/v1beta1/types_gcpprovider.go +++ b/machine/v1beta1/types_gcpprovider.go @@ -76,61 +76,61 @@ type GCPMachineProviderSpec struct { // metadata is the standard object's metadata. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata,omitempty"` - // UserDataSecret contains a local reference to a secret that contains the + // userDataSecret contains a local reference to a secret that contains the // UserData to apply to the instance // +optional UserDataSecret *corev1.LocalObjectReference `json:"userDataSecret,omitempty"` - // CredentialsSecret is a reference to the secret with GCP credentials. + // credentialsSecret is a reference to the secret with GCP credentials. // +optional CredentialsSecret *corev1.LocalObjectReference `json:"credentialsSecret,omitempty"` - // CanIPForward Allows this instance to send and receive packets with non-matching destination or source IPs. + // 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. CanIPForward bool `json:"canIPForward"` - // DeletionProtection whether the resource should be protected against deletion. + // deletionProtection whether the resource should be protected against deletion. DeletionProtection bool `json:"deletionProtection"` - // Disks is a list of disks to be attached to the VM. + // disks is a list of disks to be attached to the VM. // +optional Disks []*GCPDisk `json:"disks,omitempty"` - // Labels list of labels to apply to the VM. + // labels list of labels to apply to the VM. // +optional Labels map[string]string `json:"labels,omitempty"` // Metadata key/value pairs to apply to the VM. // +optional Metadata []*GCPMetadata `json:"gcpMetadata,omitempty"` - // NetworkInterfaces is a list of network interfaces to be attached to the VM. + // networkInterfaces is a list of network interfaces to be attached to the VM. // +optional NetworkInterfaces []*GCPNetworkInterface `json:"networkInterfaces,omitempty"` - // ServiceAccounts is a list of GCP service accounts to be used by the VM. + // serviceAccounts is a list of GCP service accounts to be used by the VM. ServiceAccounts []GCPServiceAccount `json:"serviceAccounts"` - // Tags list of network tags to apply to the VM. + // tags list of network tags to apply to the VM. Tags []string `json:"tags,omitempty"` - // TargetPools are used for network TCP/UDP load balancing. A target pool references member instances, + // 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 // +optional TargetPools []string `json:"targetPools,omitempty"` - // MachineType is the machine type to use for the VM. + // machineType is the machine type to use for the VM. MachineType string `json:"machineType"` - // Region is the region in which the GCP machine provider will create the VM. + // region is the region in which the GCP machine provider will create the VM. Region string `json:"region"` - // Zone is the zone in which the GCP machine provider will create the VM. + // zone is the zone in which the GCP machine provider will create the VM. Zone string `json:"zone"` - // ProjectID is the project in which the GCP machine provider will create the VM. + // projectID is the project in which the GCP machine provider will create the VM. // +optional ProjectID string `json:"projectID,omitempty"` - // GPUs is a list of GPUs to be attached to the VM. + // gpus is a list of GPUs to be attached to the VM. // +optional GPUs []GCPGPUConfig `json:"gpus,omitempty"` - // Preemptible indicates if created instance is preemptible. + // preemptible indicates if created instance is preemptible. // +optional Preemptible bool `json:"preemptible,omitempty"` - // OnHostMaintenance determines the behavior when a maintenance event occurs that might cause the instance to reboot. + // 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". // +kubebuilder:validation:Enum=Migrate;Terminate; // +optional OnHostMaintenance GCPHostMaintenanceType `json:"onHostMaintenance,omitempty"` - // RestartPolicy determines the behavior when an instance crashes or the underlying infrastructure provider stops the instance as part of a maintenance event (default "Always"). + // 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". @@ -139,7 +139,7 @@ type GCPMachineProviderSpec struct { // +optional RestartPolicy GCPRestartPolicyType `json:"restartPolicy,omitempty"` - // ShieldedInstanceConfig is the Shielded VM configuration for the VM + // shieldedInstanceConfig is the Shielded VM configuration for the VM // +optional ShieldedInstanceConfig GCPShieldedInstanceConfig `json:"shieldedInstanceConfig,omitempty"` @@ -169,7 +169,7 @@ type ResourceManagerTag struct { // 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. - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=32 // +kubebuilder:validation:Pattern=`(^[1-9][0-9]{0,31}$)|(^[a-z][a-z0-9-]{4,28}[a-z0-9]$)` @@ -178,7 +178,7 @@ type ResourceManagerTag struct { // 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 `._-`. - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=63 // +kubebuilder:validation:Pattern=`^[a-zA-Z0-9]([0-9A-Za-z_.-]{0,61}[a-zA-Z0-9])?$` @@ -187,7 +187,7 @@ type ResourceManagerTag struct { // 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. - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=63 // +kubebuilder:validation:Pattern=`^[a-zA-Z0-9]([0-9A-Za-z_.@%=+:,*#&()\[\]{}\-\s]{0,61}[a-zA-Z0-9])?$` @@ -196,48 +196,48 @@ type ResourceManagerTag struct { // GCPDisk describes disks for GCP. type GCPDisk struct { - // AutoDelete indicates if the disk will be auto-deleted when the instance is deleted (default false). + // autoDelete indicates if the disk will be auto-deleted when the instance is deleted (default false). AutoDelete bool `json:"autoDelete"` - // Boot indicates if this is a boot disk (default false). + // boot indicates if this is a boot disk (default false). Boot bool `json:"boot"` - // SizeGB is the size of the disk (in GB). + // sizeGb is the size of the disk (in GB). SizeGB int64 `json:"sizeGb"` - // Type is the type of the disk (eg: pd-standard). + // type is the type of the disk (eg: pd-standard). Type string `json:"type"` - // Image is the source image to create this disk. + // image is the source image to create this disk. Image string `json:"image"` - // Labels list of labels to apply to the disk. + // labels list of labels to apply to the disk. Labels map[string]string `json:"labels"` - // EncryptionKey is the customer-supplied encryption key of the disk. + // encryptionKey is the customer-supplied encryption key of the disk. // +optional EncryptionKey *GCPEncryptionKeyReference `json:"encryptionKey,omitempty"` } // GCPMetadata describes metadata for GCP. type GCPMetadata struct { - // Key is the metadata key. + // key is the metadata key. Key string `json:"key"` - // Value is the metadata value. + // value is the metadata value. Value *string `json:"value"` } // GCPNetworkInterface describes network interfaces for GCP type GCPNetworkInterface struct { - // PublicIP indicates if true a public IP will be used + // publicIP indicates if true a public IP will be used PublicIP bool `json:"publicIP,omitempty"` - // Network is the network name. + // network is the network name. Network string `json:"network,omitempty"` - // ProjectID is the project in which the GCP machine provider will create the VM. + // projectID is the project in which the GCP machine provider will create the VM. ProjectID string `json:"projectID,omitempty"` - // Subnetwork is the subnetwork name. + // subnetwork is the subnetwork name. Subnetwork string `json:"subnetwork,omitempty"` } // GCPServiceAccount describes service accounts for GCP. type GCPServiceAccount struct { - // Email is the service account email. + // email is the service account email. Email string `json:"email"` - // Scopes list of scopes to be assigned to the service account. + // scopes list of scopes to be assigned to the service account. Scopes []string `json:"scopes"` } @@ -246,7 +246,7 @@ type GCPEncryptionKeyReference struct { // KMSKeyName is the reference KMS key, in the format // +optional KMSKey *GCPKMSKeyReference `json:"kmsKey,omitempty"` - // KMSKeyServiceAccount is the service account being used for the + // 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 @@ -257,23 +257,23 @@ type GCPEncryptionKeyReference struct { // GCPKMSKeyReference gathers required fields for looking up a GCP KMS Key type GCPKMSKeyReference struct { - // Name is the name of the customer managed encryption key to be used for the disk encryption. + // name is the name of the customer managed encryption key to be used for the disk encryption. Name string `json:"name"` - // KeyRing is the name of the KMS Key Ring which the KMS Key belongs to. + // keyRing is the name of the KMS Key Ring which the KMS Key belongs to. KeyRing string `json:"keyRing"` - // ProjectID is the ID of the Project in which the KMS Key Ring exists. + // projectID is the ID of the Project in which the KMS Key Ring exists. // Defaults to the VM ProjectID if not set. // +optional ProjectID string `json:"projectID,omitempty"` - // Location is the GCP location in which the Key Ring exists. + // location is the GCP location in which the Key Ring exists. Location string `json:"location"` } // GCPGPUConfig describes type and count of GPUs attached to the instance on GCP. type GCPGPUConfig struct { - // Count is the number of GPUs to be attached to an instance. + // count is the number of GPUs to be attached to an instance. Count int32 `json:"count"` - // Type is the type of GPU to be attached to an instance. + // 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 // +kubebuilder:validation:Pattern=`^nvidia-tesla-(k80|p100|v100|p4|t4)$` Type string `json:"type"` @@ -287,13 +287,13 @@ type GCPMachineProviderStatus struct { metav1.TypeMeta `json:",inline"` // +optional metav1.ObjectMeta `json:"metadata,omitempty"` - // InstanceID is the ID of the instance in GCP + // instanceId is the ID of the instance in GCP // +optional InstanceID *string `json:"instanceId,omitempty"` - // InstanceState is the provisioning state of the GCP Instance. + // instanceState is the provisioning state of the GCP Instance. // +optional InstanceState *string `json:"instanceState,omitempty"` - // Conditions is a set of conditions associated with the Machine to indicate + // conditions is a set of conditions associated with the Machine to indicate // errors or other status // +optional Conditions []metav1.Condition `json:"conditions,omitempty"` diff --git a/machine/v1beta1/types_machine.go b/machine/v1beta1/types_machine.go index c8fcb192bd1..bd1c69dbe52 100644 --- a/machine/v1beta1/types_machine.go +++ b/machine/v1beta1/types_machine.go @@ -227,7 +227,7 @@ type MachineSpec struct { // +optional ObjectMeta `json:"metadata,omitempty"` - // LifecycleHooks allow users to pause operations on the machine at + // lifecycleHooks allow users to pause operations on the machine at // certain predefined points within the machine lifecycle. // +optional LifecycleHooks LifecycleHooks `json:"lifecycleHooks,omitempty"` @@ -242,11 +242,11 @@ type MachineSpec struct { // +listType=atomic Taints []corev1.Taint `json:"taints,omitempty"` - // ProviderSpec details Provider-specific configuration to use during node creation. + // providerSpec details Provider-specific configuration to use during node creation. // +optional ProviderSpec ProviderSpec `json:"providerSpec"` - // ProviderID is the identification ID of the machine provided by the provider. + // 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 @@ -277,14 +277,14 @@ type MachineSpec struct { // LifecycleHooks allow users to pause operations on the machine at // certain prefedined points within the machine lifecycle. type LifecycleHooks struct { - // PreDrain hooks prevent the machine from being drained. + // preDrain hooks prevent the machine from being drained. // This also blocks further lifecycle events, such as termination. // +listType=map // +listMapKey=name // +optional PreDrain []LifecycleHook `json:"preDrain,omitempty"` - // PreTerminate hooks prevent the machine from being terminated. + // preTerminate hooks prevent the machine from being terminated. // PreTerminate hooks be actioned after the Machine has been drained. // +listType=map // +listMapKey=name @@ -294,39 +294,39 @@ type LifecycleHooks struct { // LifecycleHook represents a single instance of a lifecycle hook type LifecycleHook struct { - // Name defines a unique name for the lifcycle hook. + // 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. // +kubebuilder:validation:Pattern=`^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$` // +kubebuilder:validation:MinLength=3 // +kubebuilder:validation:MaxLength=256 - // +kubebuilder:validation:Required + // +required Name string `json:"name"` - // Owner defines the owner of the lifecycle hook. + // 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. // +kubebuilder:validation:MinLength=3 // +kubebuilder:validation:MaxLength=512 - // +kubebuilder:validation:Required + // +required Owner string `json:"owner"` } // MachineStatus defines the observed state of Machine // +openshift:validation:FeatureGateAwareXValidation:featureGate=MachineAPIMigration,rule="!has(oldSelf.synchronizedGeneration) || (has(self.synchronizedGeneration) && self.synchronizedGeneration >= oldSelf.synchronizedGeneration) || (oldSelf.authoritativeAPI == 'Migrating' && self.authoritativeAPI != 'Migrating')",message="synchronizedGeneration must not decrease unless authoritativeAPI is transitioning from Migrating to another value" type MachineStatus struct { - // NodeRef will point to the corresponding Node if it exists. + // nodeRef will point to the corresponding Node if it exists. // +optional NodeRef *corev1.ObjectReference `json:"nodeRef,omitempty"` - // LastUpdated identifies when this status was last observed. + // lastUpdated identifies when this status was last observed. // +optional LastUpdated *metav1.Time `json:"lastUpdated,omitempty"` - // ErrorReason will be set in the event that there is a terminal problem + // 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. // @@ -345,7 +345,7 @@ type MachineStatus struct { // +optional ErrorReason *MachineStatusError `json:"errorReason,omitempty"` - // ErrorMessage will be set in the event that there is a terminal problem + // 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. // @@ -364,7 +364,7 @@ type MachineStatus struct { // +optional ErrorMessage *string `json:"errorMessage,omitempty"` - // ProviderStatus details a Provider-specific status. + // 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. @@ -372,24 +372,24 @@ type MachineStatus struct { // +kubebuilder:validation:XPreserveUnknownFields ProviderStatus *runtime.RawExtension `json:"providerStatus,omitempty"` - // Addresses is a list of addresses assigned to the machine. Queried from cloud provider, if available. + // addresses is a list of addresses assigned to the machine. Queried from cloud provider, if available. // +optional // +listType=atomic Addresses []corev1.NodeAddress `json:"addresses,omitempty"` - // LastOperation describes the last-operation performed by the machine-controller. + // 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. // +optional LastOperation *LastOperation `json:"lastOperation,omitempty"` - // Phase represents the current phase of machine actuation. + // phase represents the current phase of machine actuation. // One of: Failed, Provisioning, Provisioned, Running, Deleting // +optional Phase *string `json:"phase,omitempty"` - // Conditions defines the current state of the Machine + // conditions defines the current state of the Machine // +listType=map // +listMapKey=type Conditions []Condition `json:"conditions,omitempty"` @@ -415,10 +415,10 @@ type MachineStatus struct { // LastOperation represents the detail of the last performed operation on the MachineObject. type LastOperation struct { - // Description is the human-readable description of the last operation. + // description is the human-readable description of the last operation. Description *string `json:"description,omitempty"` - // LastUpdated is the timestamp at which LastOperation API was last-updated. + // lastUpdated is the timestamp at which LastOperation API was last-updated. LastUpdated *metav1.Time `json:"lastUpdated,omitempty"` // State is the current status of the last performed operation. diff --git a/machine/v1beta1/types_machinehealthcheck.go b/machine/v1beta1/types_machinehealthcheck.go index 912b7dea5db..76c79acb0b0 100644 --- a/machine/v1beta1/types_machinehealthcheck.go +++ b/machine/v1beta1/types_machinehealthcheck.go @@ -64,7 +64,7 @@ type MachineHealthCheckSpec struct { // Note: An empty selector will match all machines. Selector metav1.LabelSelector `json:"selector"` - // UnhealthyConditions contains a list of the conditions that determine + // 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. // @@ -96,7 +96,7 @@ type MachineHealthCheckSpec struct { // +optional NodeStartupTimeout *metav1.Duration `json:"nodeStartupTimeout,omitempty"` - // RemediationTemplate is a reference to a remediation template + // remediationTemplate is a reference to a remediation template // provided by an infrastructure provider. // // This field is completely optional, when filled, the MachineHealthCheck controller @@ -136,13 +136,13 @@ type MachineHealthCheckStatus struct { // +kubebuilder:validation:Minimum=0 CurrentHealthy *int `json:"currentHealthy"` - // RemediationsAllowed is the number of further remediations allowed by this machine health check before + // remediationsAllowed is the number of further remediations allowed by this machine health check before // maxUnhealthy short circuiting will be applied // +kubebuilder:validation:Minimum=0 // +optional RemediationsAllowed int32 `json:"remediationsAllowed"` - // Conditions defines the current state of the MachineHealthCheck + // conditions defines the current state of the MachineHealthCheck // +optional // +listType=map // +listMapKey=type diff --git a/machine/v1beta1/types_machineset.go b/machine/v1beta1/types_machineset.go index a14d50eb784..a29977f3474 100644 --- a/machine/v1beta1/types_machineset.go +++ b/machine/v1beta1/types_machineset.go @@ -38,25 +38,25 @@ type MachineSet struct { // MachineSetSpec defines the desired state of MachineSet type MachineSetSpec struct { - // Replicas is the number of desired replicas. + // replicas is the number of desired replicas. // This is a pointer to distinguish between explicit zero and unspecified. // Defaults to 1. // +kubebuilder:default=1 Replicas *int32 `json:"replicas,omitempty"` - // MinReadySeconds is the minimum number of seconds for which a newly created machine should be ready. + // 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) // +optional MinReadySeconds int32 `json:"minReadySeconds,omitempty"` - // DeletePolicy defines the policy used to identify nodes to delete when downscaling. + // deletePolicy defines the policy used to identify nodes to delete when downscaling. // Defaults to "Random". Valid values are "Random, "Newest", "Oldest" // +kubebuilder:validation:Enum=Random;Newest;Oldest DeletePolicy string `json:"deletePolicy,omitempty"` - // Selector is a label query over machines that should match the replica count. + // 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 Selector metav1.LabelSelector `json:"selector"` - // Template is the object that describes the machine that will be created if + // template is the object that describes the machine that will be created if // insufficient replicas are detected. // +optional Template MachineTemplateSpec `json:"template,omitempty"` @@ -113,7 +113,7 @@ type MachineTemplateSpec struct { // MachineSetStatus defines the observed state of MachineSet // +openshift:validation:FeatureGateAwareXValidation:featureGate=MachineAPIMigration,rule="!has(oldSelf.synchronizedGeneration) || (has(self.synchronizedGeneration) && self.synchronizedGeneration >= oldSelf.synchronizedGeneration) || (oldSelf.authoritativeAPI == 'Migrating' && self.authoritativeAPI != 'Migrating')",message="synchronizedGeneration must not decrease unless authoritativeAPI is transitioning from Migrating to another value" type MachineSetStatus struct { - // Replicas is the most recently observed number of replicas. + // replicas is the most recently observed number of replicas. Replicas int32 `json:"replicas"` // The number of replicas that have labels matching the labels of the machine template of the MachineSet. // +optional @@ -124,7 +124,7 @@ type MachineSetStatus struct { // The number of available replicas (ready for at least minReadySeconds) for this MachineSet. // +optional AvailableReplicas int32 `json:"availableReplicas,omitempty"` - // ObservedGeneration reflects the generation of the most recently observed MachineSet. + // observedGeneration reflects the generation of the most recently observed MachineSet. // +optional ObservedGeneration int64 `json:"observedGeneration,omitempty"` // In the event that there is a terminal problem reconciling the @@ -150,7 +150,7 @@ type MachineSetStatus struct { // +optional ErrorMessage *string `json:"errorMessage,omitempty"` - // Conditions defines the current state of the MachineSet + // conditions defines the current state of the MachineSet // +listType=map // +listMapKey=type Conditions []Condition `json:"conditions,omitempty"` diff --git a/machine/v1beta1/types_provider.go b/machine/v1beta1/types_provider.go index e9de6327836..812358e89fe 100644 --- a/machine/v1beta1/types_provider.go +++ b/machine/v1beta1/types_provider.go @@ -11,7 +11,7 @@ type ProviderSpec struct { // No more than one of the following may be specified. - // Value is an inlined, serialized representation of the resource + // 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. @@ -42,7 +42,7 @@ type ProviderSpec struct { // In future versions, controller-tools@v2 might allow overriding the type and validation for embedded // types. When that happens, this hack should be revisited. type ObjectMeta struct { - // Name must be unique within a namespace. Is required when creating resources, although + // 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. @@ -51,7 +51,7 @@ type ObjectMeta struct { // +optional Name string `json:"name,omitempty"` - // GenerateName is an optional prefix, used by the server, to generate a unique + // 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. @@ -69,7 +69,7 @@ type ObjectMeta struct { // +optional GenerateName string `json:"generateName,omitempty"` - // Namespace defines the space within each name must be unique. An empty namespace is + // 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. @@ -87,7 +87,7 @@ type ObjectMeta struct { // +optional Labels map[string]string `json:"labels,omitempty"` - // Annotations is an unstructured key value map stored with a resource that may be + // 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 @@ -193,18 +193,17 @@ const ( // Condition defines an observation of a Machine API resource operational state. type Condition struct { - // Type of condition in CamelCase or in foo.example.com/CamelCase. + // 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. // +required - // +kubebuilder:validation:Required Type ConditionType `json:"type"` - // Status of the condition, one of True, False, Unknown. + // status of the condition, one of True, False, Unknown. // +required Status corev1.ConditionStatus `json:"status"` - // Severity provides an explicit classification of Reason code, so the users or machines can immediately + // 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. // +optional diff --git a/machine/v1beta1/types_vsphereprovider.go b/machine/v1beta1/types_vsphereprovider.go index 0a0567d630a..f64266683ea 100644 --- a/machine/v1beta1/types_vsphereprovider.go +++ b/machine/v1beta1/types_vsphereprovider.go @@ -14,22 +14,22 @@ type VSphereMachineProviderSpec struct { metav1.TypeMeta `json:",inline"` // +optional metav1.ObjectMeta `json:"metadata,omitempty"` - // UserDataSecret contains a local reference to a secret that contains the + // userDataSecret contains a local reference to a secret that contains the // UserData to apply to the instance // +optional UserDataSecret *corev1.LocalObjectReference `json:"userDataSecret,omitempty"` - // CredentialsSecret is a reference to the secret with vSphere credentials. + // credentialsSecret is a reference to the secret with vSphere credentials. // +optional CredentialsSecret *corev1.LocalObjectReference `json:"credentialsSecret,omitempty"` - // Template is the name, inventory path, or instance UUID of the template + // template is the name, inventory path, or instance UUID of the template // used to clone new machines. Template string `json:"template"` - // Workspace describes the workspace to use for the machine. + // workspace describes the workspace to use for the machine. // +optional Workspace *Workspace `json:"workspace,omitempty"` - // Network is the network configuration for this machine's VM. + // network is the network configuration for this machine's VM. Network NetworkSpec `json:"network"` - // NumCPUs is the number of virtual processors in a virtual machine. + // 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. // +optional @@ -40,12 +40,12 @@ type VSphereMachineProviderSpec struct { // machine is cloned. // +optional NumCoresPerSocket int32 `json:"numCoresPerSocket,omitempty"` - // MemoryMiB is the size of a virtual machine's memory, in MiB. + // 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. // +optional MemoryMiB int64 `json:"memoryMiB,omitempty"` - // DiskGiB is the size of a virtual machine's disk, in GiB. + // 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. @@ -57,10 +57,10 @@ type VSphereMachineProviderSpec struct { // +kubebuilder:example="urn:vmomi:InventoryServiceTag:5736bf56-49f5-4667-b38c-b97e09dc9578:GLOBAL" // +optional TagIDs []string `json:"tagIDs,omitempty"` - // Snapshot is the name of the snapshot from which the VM was cloned + // snapshot is the name of the snapshot from which the VM was cloned // +optional Snapshot string `json:"snapshot"` - // CloneMode specifies the type of clone operation. + // 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. @@ -89,7 +89,7 @@ const ( // NetworkSpec defines the virtual machine's network configuration. type NetworkSpec struct { - // Devices defines the virtual machine's network interfaces. + // devices defines the virtual machine's network interfaces. Devices []NetworkDeviceSpec `json:"devices"` } @@ -100,19 +100,19 @@ type AddressesFromPool struct { // This should be a fully qualified domain name, for example, externalipam.controller.io. // +kubebuilder:example=externalipam.controller.io // +kubebuilder:validation:Pattern="^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$" - // +kubebuilder:validation:Required + // +required Group string `json:"group"` // 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. // +kubebuilder:example=ippools // +kubebuilder:validation:Pattern="^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" - // +kubebuilder:validation:Required + // +required Resource string `json:"resource"` // name of an IP address pool, for example, pool-config-1. // +kubebuilder:example=pool-config-1 // +kubebuilder:validation:Pattern="^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" - // +kubebuilder:validation:Required + // +required Name string `json:"name"` } @@ -175,19 +175,19 @@ type NetworkDeviceSpec struct { // WorkspaceConfig defines a workspace configuration for the vSphere cloud // provider. type Workspace struct { - // Server is the IP address or FQDN of the vSphere endpoint. + // server is the IP address or FQDN of the vSphere endpoint. // +optional Server string `gcfg:"server,omitempty" json:"server,omitempty"` - // Datacenter is the datacenter in which VMs are created/located. + // datacenter is the datacenter in which VMs are created/located. // +optional Datacenter string `gcfg:"datacenter,omitempty" json:"datacenter,omitempty"` - // Folder is the folder in which VMs are created/located. + // folder is the folder in which VMs are created/located. // +optional Folder string `gcfg:"folder,omitempty" json:"folder,omitempty"` - // Datastore is the datastore in which VMs are created/located. + // datastore is the datastore in which VMs are created/located. // +optional Datastore string `gcfg:"default-datastore,omitempty" json:"datastore,omitempty"` - // ResourcePool is the resource pool in which VMs are created/located. + // resourcePool is the resource pool in which VMs are created/located. // +optional ResourcePool string `gcfg:"resourcepool-path,omitempty" json:"resourcePool,omitempty"` // vmGroup is the cluster vm group in which virtual machines will be added for vm host group based zonal. @@ -203,7 +203,7 @@ type Workspace struct { type VSphereMachineProviderStatus struct { metav1.TypeMeta `json:",inline"` - // InstanceID is the ID of the instance in VSphere + // instanceId is the ID of the instance in VSphere // +optional InstanceID *string `json:"instanceId,omitempty"` // InstanceState is the provisioning state of the VSphere Instance. diff --git a/machine/v1beta1/zz_generated.crd-manifests/0000_10_machine-api_01_machinehealthchecks.crd.yaml b/machine/v1beta1/zz_generated.crd-manifests/0000_10_machine-api_01_machinehealthchecks.crd.yaml index f175e8b98ab..35ab4e03747 100644 --- a/machine/v1beta1/zz_generated.crd-manifests/0000_10_machine-api_01_machinehealthchecks.crd.yaml +++ b/machine/v1beta1/zz_generated.crd-manifests/0000_10_machine-api_01_machinehealthchecks.crd.yaml @@ -87,7 +87,7 @@ spec: type: string remediationTemplate: description: |- - RemediationTemplate is a reference to a remediation template + remediationTemplate is a reference to a remediation template provided by an infrastructure provider. This field is completely optional, when filled, the MachineHealthCheck controller @@ -184,7 +184,7 @@ spec: x-kubernetes-map-type: atomic unhealthyConditions: description: |- - UnhealthyConditions contains a list of the conditions that determine + 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. items: @@ -214,7 +214,7 @@ spec: description: Most recently observed status of MachineHealthCheck resource properties: conditions: - description: Conditions defines the current state of the MachineHealthCheck + description: conditions defines the current state of the MachineHealthCheck items: description: Condition defines an observation of a Machine API resource operational state. @@ -239,16 +239,16 @@ spec: type: string severity: description: |- - Severity provides an explicit classification of Reason code, so the users or machines can immediately + 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. + description: status of the condition, one of True, False, Unknown. type: string type: description: |- - Type of condition in CamelCase or in foo.example.com/CamelCase. + 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 @@ -273,7 +273,7 @@ spec: type: integer remediationsAllowed: description: |- - RemediationsAllowed is the number of further remediations allowed by this machine health check before + remediationsAllowed is the number of further remediations allowed by this machine health check before maxUnhealthy short circuiting will be applied format: int32 minimum: 0 diff --git a/machine/v1beta1/zz_generated.crd-manifests/0000_10_machine-api_01_machines-CustomNoUpgrade.crd.yaml b/machine/v1beta1/zz_generated.crd-manifests/0000_10_machine-api_01_machines-CustomNoUpgrade.crd.yaml index f03eba4679a..0e7c846522d 100644 --- a/machine/v1beta1/zz_generated.crd-manifests/0000_10_machine-api_01_machines-CustomNoUpgrade.crd.yaml +++ b/machine/v1beta1/zz_generated.crd-manifests/0000_10_machine-api_01_machines-CustomNoUpgrade.crd.yaml @@ -97,12 +97,12 @@ spec: type: string lifecycleHooks: description: |- - LifecycleHooks allow users to pause operations on the machine at + lifecycleHooks allow users to pause operations on the machine at certain predefined points within the machine lifecycle. properties: preDrain: description: |- - PreDrain hooks prevent the machine from being drained. + preDrain hooks prevent the machine from being drained. This also blocks further lifecycle events, such as termination. items: description: LifecycleHook represents a single instance of a @@ -110,7 +110,7 @@ spec: properties: name: description: |- - Name defines a unique name for the lifcycle hook. + 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. @@ -120,7 +120,7 @@ spec: type: string owner: description: |- - Owner defines the owner of the lifecycle hook. + 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) @@ -138,7 +138,7 @@ spec: x-kubernetes-list-type: map preTerminate: description: |- - PreTerminate hooks prevent the machine from being terminated. + preTerminate hooks prevent the machine from being terminated. PreTerminate hooks be actioned after the Machine has been drained. items: description: LifecycleHook represents a single instance of a @@ -146,7 +146,7 @@ spec: properties: name: description: |- - Name defines a unique name for the lifcycle hook. + 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. @@ -156,7 +156,7 @@ spec: type: string owner: description: |- - Owner defines the owner of the lifecycle hook. + 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) @@ -183,14 +183,14 @@ spec: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + 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 generateName: description: |- - GenerateName is an optional prefix, used by the server, to generate a unique + 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. @@ -217,7 +217,7 @@ spec: type: object name: description: |- - Name must be unique within a namespace. Is required when creating resources, although + 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. @@ -226,7 +226,7 @@ spec: type: string namespace: description: |- - Namespace defines the space within each name must be unique. An empty namespace is + 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. @@ -294,7 +294,7 @@ spec: type: object providerID: description: |- - ProviderID is the identification ID of the machine provided by the provider. + 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 @@ -306,12 +306,12 @@ spec: be interfacing with cluster-api as generic provider. type: string providerSpec: - description: ProviderSpec details Provider-specific configuration + description: providerSpec details Provider-specific configuration to use during node creation. properties: value: description: |- - Value is an inlined, serialized representation of the resource + 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. @@ -360,7 +360,7 @@ spec: description: MachineStatus defines the observed state of Machine properties: addresses: - description: Addresses is a list of addresses assigned to the machine. + description: addresses is a list of addresses assigned to the machine. Queried from cloud provider, if available. items: description: NodeAddress contains information for the node's address. @@ -396,7 +396,7 @@ spec: through Migrating. rule: self == 'Migrating' || self == oldSelf || oldSelf == 'Migrating' conditions: - description: Conditions defines the current state of the Machine + description: conditions defines the current state of the Machine items: description: Condition defines an observation of a Machine API resource operational state. @@ -421,16 +421,16 @@ spec: type: string severity: description: |- - Severity provides an explicit classification of Reason code, so the users or machines can immediately + 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. + description: status of the condition, one of True, False, Unknown. type: string type: description: |- - Type of condition in CamelCase or in foo.example.com/CamelCase. + 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 @@ -445,7 +445,7 @@ spec: x-kubernetes-list-type: map errorMessage: description: |- - ErrorMessage will be set in the event that there is a terminal problem + 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. @@ -464,7 +464,7 @@ spec: type: string errorReason: description: |- - ErrorReason will be set in the event that there is a terminal problem + 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. @@ -483,17 +483,17 @@ spec: type: string lastOperation: description: |- - LastOperation describes the last-operation performed by the machine-controller. + 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. properties: description: - description: Description is the human-readable description of + description: description is the human-readable description of the last operation. type: string lastUpdated: - description: LastUpdated is the timestamp at which LastOperation + description: lastUpdated is the timestamp at which LastOperation API was last-updated. format: date-time type: string @@ -509,11 +509,11 @@ spec: type: string type: object lastUpdated: - description: LastUpdated identifies when this status was last observed. + description: lastUpdated identifies when this status was last observed. format: date-time type: string nodeRef: - description: NodeRef will point to the corresponding Node if it exists. + description: nodeRef will point to the corresponding Node if it exists. properties: apiVersion: description: API version of the referent. @@ -557,12 +557,12 @@ spec: x-kubernetes-map-type: atomic phase: description: |- - Phase represents the current phase of machine actuation. + 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. + 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. diff --git a/machine/v1beta1/zz_generated.crd-manifests/0000_10_machine-api_01_machines-Default.crd.yaml b/machine/v1beta1/zz_generated.crd-manifests/0000_10_machine-api_01_machines-Default.crd.yaml index 6788e737b35..90ecb2b3013 100644 --- a/machine/v1beta1/zz_generated.crd-manifests/0000_10_machine-api_01_machines-Default.crd.yaml +++ b/machine/v1beta1/zz_generated.crd-manifests/0000_10_machine-api_01_machines-Default.crd.yaml @@ -83,12 +83,12 @@ spec: properties: lifecycleHooks: description: |- - LifecycleHooks allow users to pause operations on the machine at + lifecycleHooks allow users to pause operations on the machine at certain predefined points within the machine lifecycle. properties: preDrain: description: |- - PreDrain hooks prevent the machine from being drained. + preDrain hooks prevent the machine from being drained. This also blocks further lifecycle events, such as termination. items: description: LifecycleHook represents a single instance of a @@ -96,7 +96,7 @@ spec: properties: name: description: |- - Name defines a unique name for the lifcycle hook. + 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. @@ -106,7 +106,7 @@ spec: type: string owner: description: |- - Owner defines the owner of the lifecycle hook. + 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) @@ -124,7 +124,7 @@ spec: x-kubernetes-list-type: map preTerminate: description: |- - PreTerminate hooks prevent the machine from being terminated. + preTerminate hooks prevent the machine from being terminated. PreTerminate hooks be actioned after the Machine has been drained. items: description: LifecycleHook represents a single instance of a @@ -132,7 +132,7 @@ spec: properties: name: description: |- - Name defines a unique name for the lifcycle hook. + 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. @@ -142,7 +142,7 @@ spec: type: string owner: description: |- - Owner defines the owner of the lifecycle hook. + 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) @@ -169,14 +169,14 @@ spec: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + 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 generateName: description: |- - GenerateName is an optional prefix, used by the server, to generate a unique + 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. @@ -203,7 +203,7 @@ spec: type: object name: description: |- - Name must be unique within a namespace. Is required when creating resources, although + 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. @@ -212,7 +212,7 @@ spec: type: string namespace: description: |- - Namespace defines the space within each name must be unique. An empty namespace is + 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. @@ -280,7 +280,7 @@ spec: type: object providerID: description: |- - ProviderID is the identification ID of the machine provided by the provider. + 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 @@ -292,12 +292,12 @@ spec: be interfacing with cluster-api as generic provider. type: string providerSpec: - description: ProviderSpec details Provider-specific configuration + description: providerSpec details Provider-specific configuration to use during node creation. properties: value: description: |- - Value is an inlined, serialized representation of the resource + 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. @@ -346,7 +346,7 @@ spec: description: MachineStatus defines the observed state of Machine properties: addresses: - description: Addresses is a list of addresses assigned to the machine. + description: addresses is a list of addresses assigned to the machine. Queried from cloud provider, if available. items: description: NodeAddress contains information for the node's address. @@ -365,7 +365,7 @@ spec: type: array x-kubernetes-list-type: atomic conditions: - description: Conditions defines the current state of the Machine + description: conditions defines the current state of the Machine items: description: Condition defines an observation of a Machine API resource operational state. @@ -390,16 +390,16 @@ spec: type: string severity: description: |- - Severity provides an explicit classification of Reason code, so the users or machines can immediately + 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. + description: status of the condition, one of True, False, Unknown. type: string type: description: |- - Type of condition in CamelCase or in foo.example.com/CamelCase. + 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 @@ -414,7 +414,7 @@ spec: x-kubernetes-list-type: map errorMessage: description: |- - ErrorMessage will be set in the event that there is a terminal problem + 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. @@ -433,7 +433,7 @@ spec: type: string errorReason: description: |- - ErrorReason will be set in the event that there is a terminal problem + 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. @@ -452,17 +452,17 @@ spec: type: string lastOperation: description: |- - LastOperation describes the last-operation performed by the machine-controller. + 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. properties: description: - description: Description is the human-readable description of + description: description is the human-readable description of the last operation. type: string lastUpdated: - description: LastUpdated is the timestamp at which LastOperation + description: lastUpdated is the timestamp at which LastOperation API was last-updated. format: date-time type: string @@ -478,11 +478,11 @@ spec: type: string type: object lastUpdated: - description: LastUpdated identifies when this status was last observed. + description: lastUpdated identifies when this status was last observed. format: date-time type: string nodeRef: - description: NodeRef will point to the corresponding Node if it exists. + description: nodeRef will point to the corresponding Node if it exists. properties: apiVersion: description: API version of the referent. @@ -526,12 +526,12 @@ spec: x-kubernetes-map-type: atomic phase: description: |- - Phase represents the current phase of machine actuation. + 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. + 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. diff --git a/machine/v1beta1/zz_generated.crd-manifests/0000_10_machine-api_01_machines-DevPreviewNoUpgrade.crd.yaml b/machine/v1beta1/zz_generated.crd-manifests/0000_10_machine-api_01_machines-DevPreviewNoUpgrade.crd.yaml index 5d6070f8f52..00515e04e37 100644 --- a/machine/v1beta1/zz_generated.crd-manifests/0000_10_machine-api_01_machines-DevPreviewNoUpgrade.crd.yaml +++ b/machine/v1beta1/zz_generated.crd-manifests/0000_10_machine-api_01_machines-DevPreviewNoUpgrade.crd.yaml @@ -83,12 +83,12 @@ spec: properties: lifecycleHooks: description: |- - LifecycleHooks allow users to pause operations on the machine at + lifecycleHooks allow users to pause operations on the machine at certain predefined points within the machine lifecycle. properties: preDrain: description: |- - PreDrain hooks prevent the machine from being drained. + preDrain hooks prevent the machine from being drained. This also blocks further lifecycle events, such as termination. items: description: LifecycleHook represents a single instance of a @@ -96,7 +96,7 @@ spec: properties: name: description: |- - Name defines a unique name for the lifcycle hook. + 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. @@ -106,7 +106,7 @@ spec: type: string owner: description: |- - Owner defines the owner of the lifecycle hook. + 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) @@ -124,7 +124,7 @@ spec: x-kubernetes-list-type: map preTerminate: description: |- - PreTerminate hooks prevent the machine from being terminated. + preTerminate hooks prevent the machine from being terminated. PreTerminate hooks be actioned after the Machine has been drained. items: description: LifecycleHook represents a single instance of a @@ -132,7 +132,7 @@ spec: properties: name: description: |- - Name defines a unique name for the lifcycle hook. + 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. @@ -142,7 +142,7 @@ spec: type: string owner: description: |- - Owner defines the owner of the lifecycle hook. + 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) @@ -169,14 +169,14 @@ spec: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + 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 generateName: description: |- - GenerateName is an optional prefix, used by the server, to generate a unique + 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. @@ -203,7 +203,7 @@ spec: type: object name: description: |- - Name must be unique within a namespace. Is required when creating resources, although + 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. @@ -212,7 +212,7 @@ spec: type: string namespace: description: |- - Namespace defines the space within each name must be unique. An empty namespace is + 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. @@ -280,7 +280,7 @@ spec: type: object providerID: description: |- - ProviderID is the identification ID of the machine provided by the provider. + 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 @@ -292,12 +292,12 @@ spec: be interfacing with cluster-api as generic provider. type: string providerSpec: - description: ProviderSpec details Provider-specific configuration + description: providerSpec details Provider-specific configuration to use during node creation. properties: value: description: |- - Value is an inlined, serialized representation of the resource + 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. @@ -346,7 +346,7 @@ spec: description: MachineStatus defines the observed state of Machine properties: addresses: - description: Addresses is a list of addresses assigned to the machine. + description: addresses is a list of addresses assigned to the machine. Queried from cloud provider, if available. items: description: NodeAddress contains information for the node's address. @@ -365,7 +365,7 @@ spec: type: array x-kubernetes-list-type: atomic conditions: - description: Conditions defines the current state of the Machine + description: conditions defines the current state of the Machine items: description: Condition defines an observation of a Machine API resource operational state. @@ -390,16 +390,16 @@ spec: type: string severity: description: |- - Severity provides an explicit classification of Reason code, so the users or machines can immediately + 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. + description: status of the condition, one of True, False, Unknown. type: string type: description: |- - Type of condition in CamelCase or in foo.example.com/CamelCase. + 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 @@ -414,7 +414,7 @@ spec: x-kubernetes-list-type: map errorMessage: description: |- - ErrorMessage will be set in the event that there is a terminal problem + 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. @@ -433,7 +433,7 @@ spec: type: string errorReason: description: |- - ErrorReason will be set in the event that there is a terminal problem + 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. @@ -452,17 +452,17 @@ spec: type: string lastOperation: description: |- - LastOperation describes the last-operation performed by the machine-controller. + 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. properties: description: - description: Description is the human-readable description of + description: description is the human-readable description of the last operation. type: string lastUpdated: - description: LastUpdated is the timestamp at which LastOperation + description: lastUpdated is the timestamp at which LastOperation API was last-updated. format: date-time type: string @@ -478,11 +478,11 @@ spec: type: string type: object lastUpdated: - description: LastUpdated identifies when this status was last observed. + description: lastUpdated identifies when this status was last observed. format: date-time type: string nodeRef: - description: NodeRef will point to the corresponding Node if it exists. + description: nodeRef will point to the corresponding Node if it exists. properties: apiVersion: description: API version of the referent. @@ -526,12 +526,12 @@ spec: x-kubernetes-map-type: atomic phase: description: |- - Phase represents the current phase of machine actuation. + 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. + 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. diff --git a/machine/v1beta1/zz_generated.crd-manifests/0000_10_machine-api_01_machines-TechPreviewNoUpgrade.crd.yaml b/machine/v1beta1/zz_generated.crd-manifests/0000_10_machine-api_01_machines-TechPreviewNoUpgrade.crd.yaml index ca7cbe14eab..9ec0474aadc 100644 --- a/machine/v1beta1/zz_generated.crd-manifests/0000_10_machine-api_01_machines-TechPreviewNoUpgrade.crd.yaml +++ b/machine/v1beta1/zz_generated.crd-manifests/0000_10_machine-api_01_machines-TechPreviewNoUpgrade.crd.yaml @@ -83,12 +83,12 @@ spec: properties: lifecycleHooks: description: |- - LifecycleHooks allow users to pause operations on the machine at + lifecycleHooks allow users to pause operations on the machine at certain predefined points within the machine lifecycle. properties: preDrain: description: |- - PreDrain hooks prevent the machine from being drained. + preDrain hooks prevent the machine from being drained. This also blocks further lifecycle events, such as termination. items: description: LifecycleHook represents a single instance of a @@ -96,7 +96,7 @@ spec: properties: name: description: |- - Name defines a unique name for the lifcycle hook. + 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. @@ -106,7 +106,7 @@ spec: type: string owner: description: |- - Owner defines the owner of the lifecycle hook. + 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) @@ -124,7 +124,7 @@ spec: x-kubernetes-list-type: map preTerminate: description: |- - PreTerminate hooks prevent the machine from being terminated. + preTerminate hooks prevent the machine from being terminated. PreTerminate hooks be actioned after the Machine has been drained. items: description: LifecycleHook represents a single instance of a @@ -132,7 +132,7 @@ spec: properties: name: description: |- - Name defines a unique name for the lifcycle hook. + 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. @@ -142,7 +142,7 @@ spec: type: string owner: description: |- - Owner defines the owner of the lifecycle hook. + 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) @@ -169,14 +169,14 @@ spec: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + 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 generateName: description: |- - GenerateName is an optional prefix, used by the server, to generate a unique + 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. @@ -203,7 +203,7 @@ spec: type: object name: description: |- - Name must be unique within a namespace. Is required when creating resources, although + 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. @@ -212,7 +212,7 @@ spec: type: string namespace: description: |- - Namespace defines the space within each name must be unique. An empty namespace is + 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. @@ -280,7 +280,7 @@ spec: type: object providerID: description: |- - ProviderID is the identification ID of the machine provided by the provider. + 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 @@ -292,12 +292,12 @@ spec: be interfacing with cluster-api as generic provider. type: string providerSpec: - description: ProviderSpec details Provider-specific configuration + description: providerSpec details Provider-specific configuration to use during node creation. properties: value: description: |- - Value is an inlined, serialized representation of the resource + 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. @@ -346,7 +346,7 @@ spec: description: MachineStatus defines the observed state of Machine properties: addresses: - description: Addresses is a list of addresses assigned to the machine. + description: addresses is a list of addresses assigned to the machine. Queried from cloud provider, if available. items: description: NodeAddress contains information for the node's address. @@ -365,7 +365,7 @@ spec: type: array x-kubernetes-list-type: atomic conditions: - description: Conditions defines the current state of the Machine + description: conditions defines the current state of the Machine items: description: Condition defines an observation of a Machine API resource operational state. @@ -390,16 +390,16 @@ spec: type: string severity: description: |- - Severity provides an explicit classification of Reason code, so the users or machines can immediately + 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. + description: status of the condition, one of True, False, Unknown. type: string type: description: |- - Type of condition in CamelCase or in foo.example.com/CamelCase. + 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 @@ -414,7 +414,7 @@ spec: x-kubernetes-list-type: map errorMessage: description: |- - ErrorMessage will be set in the event that there is a terminal problem + 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. @@ -433,7 +433,7 @@ spec: type: string errorReason: description: |- - ErrorReason will be set in the event that there is a terminal problem + 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. @@ -452,17 +452,17 @@ spec: type: string lastOperation: description: |- - LastOperation describes the last-operation performed by the machine-controller. + 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. properties: description: - description: Description is the human-readable description of + description: description is the human-readable description of the last operation. type: string lastUpdated: - description: LastUpdated is the timestamp at which LastOperation + description: lastUpdated is the timestamp at which LastOperation API was last-updated. format: date-time type: string @@ -478,11 +478,11 @@ spec: type: string type: object lastUpdated: - description: LastUpdated identifies when this status was last observed. + description: lastUpdated identifies when this status was last observed. format: date-time type: string nodeRef: - description: NodeRef will point to the corresponding Node if it exists. + description: nodeRef will point to the corresponding Node if it exists. properties: apiVersion: description: API version of the referent. @@ -526,12 +526,12 @@ spec: x-kubernetes-map-type: atomic phase: description: |- - Phase represents the current phase of machine actuation. + 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. + 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. diff --git a/machine/v1beta1/zz_generated.crd-manifests/0000_10_machine-api_01_machinesets-CustomNoUpgrade.crd.yaml b/machine/v1beta1/zz_generated.crd-manifests/0000_10_machine-api_01_machinesets-CustomNoUpgrade.crd.yaml index 48b77e0d955..03a38c6b1ef 100644 --- a/machine/v1beta1/zz_generated.crd-manifests/0000_10_machine-api_01_machinesets-CustomNoUpgrade.crd.yaml +++ b/machine/v1beta1/zz_generated.crd-manifests/0000_10_machine-api_01_machinesets-CustomNoUpgrade.crd.yaml @@ -82,7 +82,7 @@ spec: type: string deletePolicy: description: |- - DeletePolicy defines the policy used to identify nodes to delete when downscaling. + deletePolicy defines the policy used to identify nodes to delete when downscaling. Defaults to "Random". Valid values are "Random, "Newest", "Oldest" enum: - Random @@ -91,21 +91,21 @@ spec: type: string minReadySeconds: description: |- - MinReadySeconds is the minimum number of seconds for which a newly created machine should be ready. + 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) format: int32 type: integer replicas: default: 1 description: |- - Replicas is the number of desired replicas. + replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. format: int32 type: integer selector: description: |- - Selector is a label query over machines that should match the replica count. + 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 @@ -155,7 +155,7 @@ spec: x-kubernetes-map-type: atomic template: description: |- - Template is the object that describes the machine that will be created if + template is the object that describes the machine that will be created if insufficient replicas are detected. properties: metadata: @@ -167,14 +167,14 @@ spec: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + 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 generateName: description: |- - GenerateName is an optional prefix, used by the server, to generate a unique + 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. @@ -201,7 +201,7 @@ spec: type: object name: description: |- - Name must be unique within a namespace. Is required when creating resources, although + 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. @@ -210,7 +210,7 @@ spec: type: string namespace: description: |- - Namespace defines the space within each name must be unique. An empty namespace is + 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. @@ -297,12 +297,12 @@ spec: type: string lifecycleHooks: description: |- - LifecycleHooks allow users to pause operations on the machine at + lifecycleHooks allow users to pause operations on the machine at certain predefined points within the machine lifecycle. properties: preDrain: description: |- - PreDrain hooks prevent the machine from being drained. + preDrain hooks prevent the machine from being drained. This also blocks further lifecycle events, such as termination. items: description: LifecycleHook represents a single instance @@ -310,7 +310,7 @@ spec: properties: name: description: |- - Name defines a unique name for the lifcycle hook. + 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. @@ -320,7 +320,7 @@ spec: type: string owner: description: |- - Owner defines the owner of the lifecycle hook. + 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) @@ -338,7 +338,7 @@ spec: x-kubernetes-list-type: map preTerminate: description: |- - PreTerminate hooks prevent the machine from being terminated. + preTerminate hooks prevent the machine from being terminated. PreTerminate hooks be actioned after the Machine has been drained. items: description: LifecycleHook represents a single instance @@ -346,7 +346,7 @@ spec: properties: name: description: |- - Name defines a unique name for the lifcycle hook. + 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. @@ -356,7 +356,7 @@ spec: type: string owner: description: |- - Owner defines the owner of the lifecycle hook. + 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) @@ -383,14 +383,14 @@ spec: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + 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 generateName: description: |- - GenerateName is an optional prefix, used by the server, to generate a unique + 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. @@ -417,7 +417,7 @@ spec: type: object name: description: |- - Name must be unique within a namespace. Is required when creating resources, although + 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. @@ -426,7 +426,7 @@ spec: type: string namespace: description: |- - Namespace defines the space within each name must be unique. An empty namespace is + 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. @@ -494,7 +494,7 @@ spec: type: object providerID: description: |- - ProviderID is the identification ID of the machine provided by the provider. + 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 @@ -506,12 +506,12 @@ spec: be interfacing with cluster-api as generic provider. type: string providerSpec: - description: ProviderSpec details Provider-specific configuration + description: providerSpec details Provider-specific configuration to use during node creation. properties: value: description: |- - Value is an inlined, serialized representation of the resource + 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. @@ -586,7 +586,7 @@ spec: format: int32 type: integer conditions: - description: Conditions defines the current state of the MachineSet + description: conditions defines the current state of the MachineSet items: description: Condition defines an observation of a Machine API resource operational state. @@ -611,16 +611,16 @@ spec: type: string severity: description: |- - Severity provides an explicit classification of Reason code, so the users or machines can immediately + 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. + description: status of the condition, one of True, False, Unknown. type: string type: description: |- - Type of condition in CamelCase or in foo.example.com/CamelCase. + 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 @@ -662,7 +662,7 @@ spec: format: int32 type: integer observedGeneration: - description: ObservedGeneration reflects the generation of the most + description: observedGeneration reflects the generation of the most recently observed MachineSet. format: int64 type: integer @@ -672,7 +672,7 @@ spec: format: int32 type: integer replicas: - description: Replicas is the most recently observed number of replicas. + description: replicas is the most recently observed number of replicas. format: int32 type: integer synchronizedGeneration: diff --git a/machine/v1beta1/zz_generated.crd-manifests/0000_10_machine-api_01_machinesets-Default.crd.yaml b/machine/v1beta1/zz_generated.crd-manifests/0000_10_machine-api_01_machinesets-Default.crd.yaml index 98180dd7002..93af026a789 100644 --- a/machine/v1beta1/zz_generated.crd-manifests/0000_10_machine-api_01_machinesets-Default.crd.yaml +++ b/machine/v1beta1/zz_generated.crd-manifests/0000_10_machine-api_01_machinesets-Default.crd.yaml @@ -68,7 +68,7 @@ spec: properties: deletePolicy: description: |- - DeletePolicy defines the policy used to identify nodes to delete when downscaling. + deletePolicy defines the policy used to identify nodes to delete when downscaling. Defaults to "Random". Valid values are "Random, "Newest", "Oldest" enum: - Random @@ -77,21 +77,21 @@ spec: type: string minReadySeconds: description: |- - MinReadySeconds is the minimum number of seconds for which a newly created machine should be ready. + 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) format: int32 type: integer replicas: default: 1 description: |- - Replicas is the number of desired replicas. + replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. format: int32 type: integer selector: description: |- - Selector is a label query over machines that should match the replica count. + 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 @@ -141,7 +141,7 @@ spec: x-kubernetes-map-type: atomic template: description: |- - Template is the object that describes the machine that will be created if + template is the object that describes the machine that will be created if insufficient replicas are detected. properties: metadata: @@ -153,14 +153,14 @@ spec: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + 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 generateName: description: |- - GenerateName is an optional prefix, used by the server, to generate a unique + 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. @@ -187,7 +187,7 @@ spec: type: object name: description: |- - Name must be unique within a namespace. Is required when creating resources, although + 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. @@ -196,7 +196,7 @@ spec: type: string namespace: description: |- - Namespace defines the space within each name must be unique. An empty namespace is + 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. @@ -269,12 +269,12 @@ spec: properties: lifecycleHooks: description: |- - LifecycleHooks allow users to pause operations on the machine at + lifecycleHooks allow users to pause operations on the machine at certain predefined points within the machine lifecycle. properties: preDrain: description: |- - PreDrain hooks prevent the machine from being drained. + preDrain hooks prevent the machine from being drained. This also blocks further lifecycle events, such as termination. items: description: LifecycleHook represents a single instance @@ -282,7 +282,7 @@ spec: properties: name: description: |- - Name defines a unique name for the lifcycle hook. + 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. @@ -292,7 +292,7 @@ spec: type: string owner: description: |- - Owner defines the owner of the lifecycle hook. + 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) @@ -310,7 +310,7 @@ spec: x-kubernetes-list-type: map preTerminate: description: |- - PreTerminate hooks prevent the machine from being terminated. + preTerminate hooks prevent the machine from being terminated. PreTerminate hooks be actioned after the Machine has been drained. items: description: LifecycleHook represents a single instance @@ -318,7 +318,7 @@ spec: properties: name: description: |- - Name defines a unique name for the lifcycle hook. + 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. @@ -328,7 +328,7 @@ spec: type: string owner: description: |- - Owner defines the owner of the lifecycle hook. + 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) @@ -355,14 +355,14 @@ spec: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + 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 generateName: description: |- - GenerateName is an optional prefix, used by the server, to generate a unique + 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. @@ -389,7 +389,7 @@ spec: type: object name: description: |- - Name must be unique within a namespace. Is required when creating resources, although + 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. @@ -398,7 +398,7 @@ spec: type: string namespace: description: |- - Namespace defines the space within each name must be unique. An empty namespace is + 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. @@ -466,7 +466,7 @@ spec: type: object providerID: description: |- - ProviderID is the identification ID of the machine provided by the provider. + 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 @@ -478,12 +478,12 @@ spec: be interfacing with cluster-api as generic provider. type: string providerSpec: - description: ProviderSpec details Provider-specific configuration + description: providerSpec details Provider-specific configuration to use during node creation. properties: value: description: |- - Value is an inlined, serialized representation of the resource + 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. @@ -541,7 +541,7 @@ spec: format: int32 type: integer conditions: - description: Conditions defines the current state of the MachineSet + description: conditions defines the current state of the MachineSet items: description: Condition defines an observation of a Machine API resource operational state. @@ -566,16 +566,16 @@ spec: type: string severity: description: |- - Severity provides an explicit classification of Reason code, so the users or machines can immediately + 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. + description: status of the condition, one of True, False, Unknown. type: string type: description: |- - Type of condition in CamelCase or in foo.example.com/CamelCase. + 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 @@ -617,7 +617,7 @@ spec: format: int32 type: integer observedGeneration: - description: ObservedGeneration reflects the generation of the most + description: observedGeneration reflects the generation of the most recently observed MachineSet. format: int64 type: integer @@ -627,7 +627,7 @@ spec: format: int32 type: integer replicas: - description: Replicas is the most recently observed number of replicas. + description: replicas is the most recently observed number of replicas. format: int32 type: integer type: object diff --git a/machine/v1beta1/zz_generated.crd-manifests/0000_10_machine-api_01_machinesets-DevPreviewNoUpgrade.crd.yaml b/machine/v1beta1/zz_generated.crd-manifests/0000_10_machine-api_01_machinesets-DevPreviewNoUpgrade.crd.yaml index 74ff9ac76bb..6da86259ddd 100644 --- a/machine/v1beta1/zz_generated.crd-manifests/0000_10_machine-api_01_machinesets-DevPreviewNoUpgrade.crd.yaml +++ b/machine/v1beta1/zz_generated.crd-manifests/0000_10_machine-api_01_machinesets-DevPreviewNoUpgrade.crd.yaml @@ -68,7 +68,7 @@ spec: properties: deletePolicy: description: |- - DeletePolicy defines the policy used to identify nodes to delete when downscaling. + deletePolicy defines the policy used to identify nodes to delete when downscaling. Defaults to "Random". Valid values are "Random, "Newest", "Oldest" enum: - Random @@ -77,21 +77,21 @@ spec: type: string minReadySeconds: description: |- - MinReadySeconds is the minimum number of seconds for which a newly created machine should be ready. + 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) format: int32 type: integer replicas: default: 1 description: |- - Replicas is the number of desired replicas. + replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. format: int32 type: integer selector: description: |- - Selector is a label query over machines that should match the replica count. + 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 @@ -141,7 +141,7 @@ spec: x-kubernetes-map-type: atomic template: description: |- - Template is the object that describes the machine that will be created if + template is the object that describes the machine that will be created if insufficient replicas are detected. properties: metadata: @@ -153,14 +153,14 @@ spec: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + 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 generateName: description: |- - GenerateName is an optional prefix, used by the server, to generate a unique + 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. @@ -187,7 +187,7 @@ spec: type: object name: description: |- - Name must be unique within a namespace. Is required when creating resources, although + 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. @@ -196,7 +196,7 @@ spec: type: string namespace: description: |- - Namespace defines the space within each name must be unique. An empty namespace is + 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. @@ -269,12 +269,12 @@ spec: properties: lifecycleHooks: description: |- - LifecycleHooks allow users to pause operations on the machine at + lifecycleHooks allow users to pause operations on the machine at certain predefined points within the machine lifecycle. properties: preDrain: description: |- - PreDrain hooks prevent the machine from being drained. + preDrain hooks prevent the machine from being drained. This also blocks further lifecycle events, such as termination. items: description: LifecycleHook represents a single instance @@ -282,7 +282,7 @@ spec: properties: name: description: |- - Name defines a unique name for the lifcycle hook. + 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. @@ -292,7 +292,7 @@ spec: type: string owner: description: |- - Owner defines the owner of the lifecycle hook. + 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) @@ -310,7 +310,7 @@ spec: x-kubernetes-list-type: map preTerminate: description: |- - PreTerminate hooks prevent the machine from being terminated. + preTerminate hooks prevent the machine from being terminated. PreTerminate hooks be actioned after the Machine has been drained. items: description: LifecycleHook represents a single instance @@ -318,7 +318,7 @@ spec: properties: name: description: |- - Name defines a unique name for the lifcycle hook. + 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. @@ -328,7 +328,7 @@ spec: type: string owner: description: |- - Owner defines the owner of the lifecycle hook. + 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) @@ -355,14 +355,14 @@ spec: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + 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 generateName: description: |- - GenerateName is an optional prefix, used by the server, to generate a unique + 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. @@ -389,7 +389,7 @@ spec: type: object name: description: |- - Name must be unique within a namespace. Is required when creating resources, although + 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. @@ -398,7 +398,7 @@ spec: type: string namespace: description: |- - Namespace defines the space within each name must be unique. An empty namespace is + 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. @@ -466,7 +466,7 @@ spec: type: object providerID: description: |- - ProviderID is the identification ID of the machine provided by the provider. + 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 @@ -478,12 +478,12 @@ spec: be interfacing with cluster-api as generic provider. type: string providerSpec: - description: ProviderSpec details Provider-specific configuration + description: providerSpec details Provider-specific configuration to use during node creation. properties: value: description: |- - Value is an inlined, serialized representation of the resource + 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. @@ -541,7 +541,7 @@ spec: format: int32 type: integer conditions: - description: Conditions defines the current state of the MachineSet + description: conditions defines the current state of the MachineSet items: description: Condition defines an observation of a Machine API resource operational state. @@ -566,16 +566,16 @@ spec: type: string severity: description: |- - Severity provides an explicit classification of Reason code, so the users or machines can immediately + 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. + description: status of the condition, one of True, False, Unknown. type: string type: description: |- - Type of condition in CamelCase or in foo.example.com/CamelCase. + 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 @@ -617,7 +617,7 @@ spec: format: int32 type: integer observedGeneration: - description: ObservedGeneration reflects the generation of the most + description: observedGeneration reflects the generation of the most recently observed MachineSet. format: int64 type: integer @@ -627,7 +627,7 @@ spec: format: int32 type: integer replicas: - description: Replicas is the most recently observed number of replicas. + description: replicas is the most recently observed number of replicas. format: int32 type: integer type: object diff --git a/machine/v1beta1/zz_generated.crd-manifests/0000_10_machine-api_01_machinesets-TechPreviewNoUpgrade.crd.yaml b/machine/v1beta1/zz_generated.crd-manifests/0000_10_machine-api_01_machinesets-TechPreviewNoUpgrade.crd.yaml index a218da06c15..51bbf02e04a 100644 --- a/machine/v1beta1/zz_generated.crd-manifests/0000_10_machine-api_01_machinesets-TechPreviewNoUpgrade.crd.yaml +++ b/machine/v1beta1/zz_generated.crd-manifests/0000_10_machine-api_01_machinesets-TechPreviewNoUpgrade.crd.yaml @@ -68,7 +68,7 @@ spec: properties: deletePolicy: description: |- - DeletePolicy defines the policy used to identify nodes to delete when downscaling. + deletePolicy defines the policy used to identify nodes to delete when downscaling. Defaults to "Random". Valid values are "Random, "Newest", "Oldest" enum: - Random @@ -77,21 +77,21 @@ spec: type: string minReadySeconds: description: |- - MinReadySeconds is the minimum number of seconds for which a newly created machine should be ready. + 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) format: int32 type: integer replicas: default: 1 description: |- - Replicas is the number of desired replicas. + replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. format: int32 type: integer selector: description: |- - Selector is a label query over machines that should match the replica count. + 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 @@ -141,7 +141,7 @@ spec: x-kubernetes-map-type: atomic template: description: |- - Template is the object that describes the machine that will be created if + template is the object that describes the machine that will be created if insufficient replicas are detected. properties: metadata: @@ -153,14 +153,14 @@ spec: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + 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 generateName: description: |- - GenerateName is an optional prefix, used by the server, to generate a unique + 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. @@ -187,7 +187,7 @@ spec: type: object name: description: |- - Name must be unique within a namespace. Is required when creating resources, although + 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. @@ -196,7 +196,7 @@ spec: type: string namespace: description: |- - Namespace defines the space within each name must be unique. An empty namespace is + 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. @@ -269,12 +269,12 @@ spec: properties: lifecycleHooks: description: |- - LifecycleHooks allow users to pause operations on the machine at + lifecycleHooks allow users to pause operations on the machine at certain predefined points within the machine lifecycle. properties: preDrain: description: |- - PreDrain hooks prevent the machine from being drained. + preDrain hooks prevent the machine from being drained. This also blocks further lifecycle events, such as termination. items: description: LifecycleHook represents a single instance @@ -282,7 +282,7 @@ spec: properties: name: description: |- - Name defines a unique name for the lifcycle hook. + 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. @@ -292,7 +292,7 @@ spec: type: string owner: description: |- - Owner defines the owner of the lifecycle hook. + 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) @@ -310,7 +310,7 @@ spec: x-kubernetes-list-type: map preTerminate: description: |- - PreTerminate hooks prevent the machine from being terminated. + preTerminate hooks prevent the machine from being terminated. PreTerminate hooks be actioned after the Machine has been drained. items: description: LifecycleHook represents a single instance @@ -318,7 +318,7 @@ spec: properties: name: description: |- - Name defines a unique name for the lifcycle hook. + 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. @@ -328,7 +328,7 @@ spec: type: string owner: description: |- - Owner defines the owner of the lifecycle hook. + 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) @@ -355,14 +355,14 @@ spec: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + 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 generateName: description: |- - GenerateName is an optional prefix, used by the server, to generate a unique + 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. @@ -389,7 +389,7 @@ spec: type: object name: description: |- - Name must be unique within a namespace. Is required when creating resources, although + 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. @@ -398,7 +398,7 @@ spec: type: string namespace: description: |- - Namespace defines the space within each name must be unique. An empty namespace is + 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. @@ -466,7 +466,7 @@ spec: type: object providerID: description: |- - ProviderID is the identification ID of the machine provided by the provider. + 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 @@ -478,12 +478,12 @@ spec: be interfacing with cluster-api as generic provider. type: string providerSpec: - description: ProviderSpec details Provider-specific configuration + description: providerSpec details Provider-specific configuration to use during node creation. properties: value: description: |- - Value is an inlined, serialized representation of the resource + 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. @@ -541,7 +541,7 @@ spec: format: int32 type: integer conditions: - description: Conditions defines the current state of the MachineSet + description: conditions defines the current state of the MachineSet items: description: Condition defines an observation of a Machine API resource operational state. @@ -566,16 +566,16 @@ spec: type: string severity: description: |- - Severity provides an explicit classification of Reason code, so the users or machines can immediately + 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. + description: status of the condition, one of True, False, Unknown. type: string type: description: |- - Type of condition in CamelCase or in foo.example.com/CamelCase. + 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 @@ -617,7 +617,7 @@ spec: format: int32 type: integer observedGeneration: - description: ObservedGeneration reflects the generation of the most + description: observedGeneration reflects the generation of the most recently observed MachineSet. format: int64 type: integer @@ -627,7 +627,7 @@ spec: format: int32 type: integer replicas: - description: Replicas is the most recently observed number of replicas. + description: replicas is the most recently observed number of replicas. format: int32 type: integer type: object diff --git a/machine/v1beta1/zz_generated.featuregated-crd-manifests/machinehealthchecks.machine.openshift.io/AAA_ungated.yaml b/machine/v1beta1/zz_generated.featuregated-crd-manifests/machinehealthchecks.machine.openshift.io/AAA_ungated.yaml index c7fdabec2a8..0e2cb3e011d 100644 --- a/machine/v1beta1/zz_generated.featuregated-crd-manifests/machinehealthchecks.machine.openshift.io/AAA_ungated.yaml +++ b/machine/v1beta1/zz_generated.featuregated-crd-manifests/machinehealthchecks.machine.openshift.io/AAA_ungated.yaml @@ -90,7 +90,7 @@ spec: type: string remediationTemplate: description: |- - RemediationTemplate is a reference to a remediation template + remediationTemplate is a reference to a remediation template provided by an infrastructure provider. This field is completely optional, when filled, the MachineHealthCheck controller @@ -187,7 +187,7 @@ spec: x-kubernetes-map-type: atomic unhealthyConditions: description: |- - UnhealthyConditions contains a list of the conditions that determine + 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. items: @@ -217,7 +217,7 @@ spec: description: Most recently observed status of MachineHealthCheck resource properties: conditions: - description: Conditions defines the current state of the MachineHealthCheck + description: conditions defines the current state of the MachineHealthCheck items: description: Condition defines an observation of a Machine API resource operational state. @@ -242,16 +242,16 @@ spec: type: string severity: description: |- - Severity provides an explicit classification of Reason code, so the users or machines can immediately + 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. + description: status of the condition, one of True, False, Unknown. type: string type: description: |- - Type of condition in CamelCase or in foo.example.com/CamelCase. + 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 @@ -276,7 +276,7 @@ spec: type: integer remediationsAllowed: description: |- - RemediationsAllowed is the number of further remediations allowed by this machine health check before + remediationsAllowed is the number of further remediations allowed by this machine health check before maxUnhealthy short circuiting will be applied format: int32 minimum: 0 diff --git a/machine/v1beta1/zz_generated.featuregated-crd-manifests/machines.machine.openshift.io/AAA_ungated.yaml b/machine/v1beta1/zz_generated.featuregated-crd-manifests/machines.machine.openshift.io/AAA_ungated.yaml index 08c7c9e653d..a21873105bb 100644 --- a/machine/v1beta1/zz_generated.featuregated-crd-manifests/machines.machine.openshift.io/AAA_ungated.yaml +++ b/machine/v1beta1/zz_generated.featuregated-crd-manifests/machines.machine.openshift.io/AAA_ungated.yaml @@ -85,12 +85,12 @@ spec: properties: lifecycleHooks: description: |- - LifecycleHooks allow users to pause operations on the machine at + lifecycleHooks allow users to pause operations on the machine at certain predefined points within the machine lifecycle. properties: preDrain: description: |- - PreDrain hooks prevent the machine from being drained. + preDrain hooks prevent the machine from being drained. This also blocks further lifecycle events, such as termination. items: description: LifecycleHook represents a single instance of a @@ -98,7 +98,7 @@ spec: properties: name: description: |- - Name defines a unique name for the lifcycle hook. + 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. @@ -108,7 +108,7 @@ spec: type: string owner: description: |- - Owner defines the owner of the lifecycle hook. + 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) @@ -126,7 +126,7 @@ spec: x-kubernetes-list-type: map preTerminate: description: |- - PreTerminate hooks prevent the machine from being terminated. + preTerminate hooks prevent the machine from being terminated. PreTerminate hooks be actioned after the Machine has been drained. items: description: LifecycleHook represents a single instance of a @@ -134,7 +134,7 @@ spec: properties: name: description: |- - Name defines a unique name for the lifcycle hook. + 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. @@ -144,7 +144,7 @@ spec: type: string owner: description: |- - Owner defines the owner of the lifecycle hook. + 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) @@ -171,14 +171,14 @@ spec: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + 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 generateName: description: |- - GenerateName is an optional prefix, used by the server, to generate a unique + 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. @@ -205,7 +205,7 @@ spec: type: object name: description: |- - Name must be unique within a namespace. Is required when creating resources, although + 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. @@ -214,7 +214,7 @@ spec: type: string namespace: description: |- - Namespace defines the space within each name must be unique. An empty namespace is + 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. @@ -282,7 +282,7 @@ spec: type: object providerID: description: |- - ProviderID is the identification ID of the machine provided by the provider. + 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 @@ -294,12 +294,12 @@ spec: be interfacing with cluster-api as generic provider. type: string providerSpec: - description: ProviderSpec details Provider-specific configuration + description: providerSpec details Provider-specific configuration to use during node creation. properties: value: description: |- - Value is an inlined, serialized representation of the resource + 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. @@ -348,7 +348,7 @@ spec: description: MachineStatus defines the observed state of Machine properties: addresses: - description: Addresses is a list of addresses assigned to the machine. + description: addresses is a list of addresses assigned to the machine. Queried from cloud provider, if available. items: description: NodeAddress contains information for the node's address. @@ -367,7 +367,7 @@ spec: type: array x-kubernetes-list-type: atomic conditions: - description: Conditions defines the current state of the Machine + description: conditions defines the current state of the Machine items: description: Condition defines an observation of a Machine API resource operational state. @@ -392,16 +392,16 @@ spec: type: string severity: description: |- - Severity provides an explicit classification of Reason code, so the users or machines can immediately + 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. + description: status of the condition, one of True, False, Unknown. type: string type: description: |- - Type of condition in CamelCase or in foo.example.com/CamelCase. + 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 @@ -416,7 +416,7 @@ spec: x-kubernetes-list-type: map errorMessage: description: |- - ErrorMessage will be set in the event that there is a terminal problem + 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. @@ -435,7 +435,7 @@ spec: type: string errorReason: description: |- - ErrorReason will be set in the event that there is a terminal problem + 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. @@ -454,17 +454,17 @@ spec: type: string lastOperation: description: |- - LastOperation describes the last-operation performed by the machine-controller. + 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. properties: description: - description: Description is the human-readable description of + description: description is the human-readable description of the last operation. type: string lastUpdated: - description: LastUpdated is the timestamp at which LastOperation + description: lastUpdated is the timestamp at which LastOperation API was last-updated. format: date-time type: string @@ -480,11 +480,11 @@ spec: type: string type: object lastUpdated: - description: LastUpdated identifies when this status was last observed. + description: lastUpdated identifies when this status was last observed. format: date-time type: string nodeRef: - description: NodeRef will point to the corresponding Node if it exists. + description: nodeRef will point to the corresponding Node if it exists. properties: apiVersion: description: API version of the referent. @@ -528,12 +528,12 @@ spec: x-kubernetes-map-type: atomic phase: description: |- - Phase represents the current phase of machine actuation. + 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. + 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. diff --git a/machine/v1beta1/zz_generated.featuregated-crd-manifests/machines.machine.openshift.io/MachineAPIMigration.yaml b/machine/v1beta1/zz_generated.featuregated-crd-manifests/machines.machine.openshift.io/MachineAPIMigration.yaml index 49eb6909a9e..430f92a5425 100644 --- a/machine/v1beta1/zz_generated.featuregated-crd-manifests/machines.machine.openshift.io/MachineAPIMigration.yaml +++ b/machine/v1beta1/zz_generated.featuregated-crd-manifests/machines.machine.openshift.io/MachineAPIMigration.yaml @@ -99,12 +99,12 @@ spec: type: string lifecycleHooks: description: |- - LifecycleHooks allow users to pause operations on the machine at + lifecycleHooks allow users to pause operations on the machine at certain predefined points within the machine lifecycle. properties: preDrain: description: |- - PreDrain hooks prevent the machine from being drained. + preDrain hooks prevent the machine from being drained. This also blocks further lifecycle events, such as termination. items: description: LifecycleHook represents a single instance of a @@ -112,7 +112,7 @@ spec: properties: name: description: |- - Name defines a unique name for the lifcycle hook. + 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. @@ -122,7 +122,7 @@ spec: type: string owner: description: |- - Owner defines the owner of the lifecycle hook. + 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) @@ -140,7 +140,7 @@ spec: x-kubernetes-list-type: map preTerminate: description: |- - PreTerminate hooks prevent the machine from being terminated. + preTerminate hooks prevent the machine from being terminated. PreTerminate hooks be actioned after the Machine has been drained. items: description: LifecycleHook represents a single instance of a @@ -148,7 +148,7 @@ spec: properties: name: description: |- - Name defines a unique name for the lifcycle hook. + 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. @@ -158,7 +158,7 @@ spec: type: string owner: description: |- - Owner defines the owner of the lifecycle hook. + 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) @@ -185,14 +185,14 @@ spec: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + 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 generateName: description: |- - GenerateName is an optional prefix, used by the server, to generate a unique + 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. @@ -219,7 +219,7 @@ spec: type: object name: description: |- - Name must be unique within a namespace. Is required when creating resources, although + 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. @@ -228,7 +228,7 @@ spec: type: string namespace: description: |- - Namespace defines the space within each name must be unique. An empty namespace is + 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. @@ -296,7 +296,7 @@ spec: type: object providerID: description: |- - ProviderID is the identification ID of the machine provided by the provider. + 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 @@ -308,12 +308,12 @@ spec: be interfacing with cluster-api as generic provider. type: string providerSpec: - description: ProviderSpec details Provider-specific configuration + description: providerSpec details Provider-specific configuration to use during node creation. properties: value: description: |- - Value is an inlined, serialized representation of the resource + 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. @@ -362,7 +362,7 @@ spec: description: MachineStatus defines the observed state of Machine properties: addresses: - description: Addresses is a list of addresses assigned to the machine. + description: addresses is a list of addresses assigned to the machine. Queried from cloud provider, if available. items: description: NodeAddress contains information for the node's address. @@ -398,7 +398,7 @@ spec: through Migrating. rule: self == 'Migrating' || self == oldSelf || oldSelf == 'Migrating' conditions: - description: Conditions defines the current state of the Machine + description: conditions defines the current state of the Machine items: description: Condition defines an observation of a Machine API resource operational state. @@ -423,16 +423,16 @@ spec: type: string severity: description: |- - Severity provides an explicit classification of Reason code, so the users or machines can immediately + 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. + description: status of the condition, one of True, False, Unknown. type: string type: description: |- - Type of condition in CamelCase or in foo.example.com/CamelCase. + 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 @@ -447,7 +447,7 @@ spec: x-kubernetes-list-type: map errorMessage: description: |- - ErrorMessage will be set in the event that there is a terminal problem + 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. @@ -466,7 +466,7 @@ spec: type: string errorReason: description: |- - ErrorReason will be set in the event that there is a terminal problem + 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. @@ -485,17 +485,17 @@ spec: type: string lastOperation: description: |- - LastOperation describes the last-operation performed by the machine-controller. + 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. properties: description: - description: Description is the human-readable description of + description: description is the human-readable description of the last operation. type: string lastUpdated: - description: LastUpdated is the timestamp at which LastOperation + description: lastUpdated is the timestamp at which LastOperation API was last-updated. format: date-time type: string @@ -511,11 +511,11 @@ spec: type: string type: object lastUpdated: - description: LastUpdated identifies when this status was last observed. + description: lastUpdated identifies when this status was last observed. format: date-time type: string nodeRef: - description: NodeRef will point to the corresponding Node if it exists. + description: nodeRef will point to the corresponding Node if it exists. properties: apiVersion: description: API version of the referent. @@ -559,12 +559,12 @@ spec: x-kubernetes-map-type: atomic phase: description: |- - Phase represents the current phase of machine actuation. + 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. + 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. diff --git a/machine/v1beta1/zz_generated.featuregated-crd-manifests/machinesets.machine.openshift.io/AAA_ungated.yaml b/machine/v1beta1/zz_generated.featuregated-crd-manifests/machinesets.machine.openshift.io/AAA_ungated.yaml index 009b4a352da..936aca06070 100644 --- a/machine/v1beta1/zz_generated.featuregated-crd-manifests/machinesets.machine.openshift.io/AAA_ungated.yaml +++ b/machine/v1beta1/zz_generated.featuregated-crd-manifests/machinesets.machine.openshift.io/AAA_ungated.yaml @@ -70,7 +70,7 @@ spec: properties: deletePolicy: description: |- - DeletePolicy defines the policy used to identify nodes to delete when downscaling. + deletePolicy defines the policy used to identify nodes to delete when downscaling. Defaults to "Random". Valid values are "Random, "Newest", "Oldest" enum: - Random @@ -79,21 +79,21 @@ spec: type: string minReadySeconds: description: |- - MinReadySeconds is the minimum number of seconds for which a newly created machine should be ready. + 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) format: int32 type: integer replicas: default: 1 description: |- - Replicas is the number of desired replicas. + replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. format: int32 type: integer selector: description: |- - Selector is a label query over machines that should match the replica count. + 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 @@ -143,7 +143,7 @@ spec: x-kubernetes-map-type: atomic template: description: |- - Template is the object that describes the machine that will be created if + template is the object that describes the machine that will be created if insufficient replicas are detected. properties: metadata: @@ -155,14 +155,14 @@ spec: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + 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 generateName: description: |- - GenerateName is an optional prefix, used by the server, to generate a unique + 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. @@ -189,7 +189,7 @@ spec: type: object name: description: |- - Name must be unique within a namespace. Is required when creating resources, although + 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. @@ -198,7 +198,7 @@ spec: type: string namespace: description: |- - Namespace defines the space within each name must be unique. An empty namespace is + 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. @@ -271,12 +271,12 @@ spec: properties: lifecycleHooks: description: |- - LifecycleHooks allow users to pause operations on the machine at + lifecycleHooks allow users to pause operations on the machine at certain predefined points within the machine lifecycle. properties: preDrain: description: |- - PreDrain hooks prevent the machine from being drained. + preDrain hooks prevent the machine from being drained. This also blocks further lifecycle events, such as termination. items: description: LifecycleHook represents a single instance @@ -284,7 +284,7 @@ spec: properties: name: description: |- - Name defines a unique name for the lifcycle hook. + 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. @@ -294,7 +294,7 @@ spec: type: string owner: description: |- - Owner defines the owner of the lifecycle hook. + 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) @@ -312,7 +312,7 @@ spec: x-kubernetes-list-type: map preTerminate: description: |- - PreTerminate hooks prevent the machine from being terminated. + preTerminate hooks prevent the machine from being terminated. PreTerminate hooks be actioned after the Machine has been drained. items: description: LifecycleHook represents a single instance @@ -320,7 +320,7 @@ spec: properties: name: description: |- - Name defines a unique name for the lifcycle hook. + 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. @@ -330,7 +330,7 @@ spec: type: string owner: description: |- - Owner defines the owner of the lifecycle hook. + 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) @@ -357,14 +357,14 @@ spec: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + 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 generateName: description: |- - GenerateName is an optional prefix, used by the server, to generate a unique + 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. @@ -391,7 +391,7 @@ spec: type: object name: description: |- - Name must be unique within a namespace. Is required when creating resources, although + 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. @@ -400,7 +400,7 @@ spec: type: string namespace: description: |- - Namespace defines the space within each name must be unique. An empty namespace is + 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. @@ -468,7 +468,7 @@ spec: type: object providerID: description: |- - ProviderID is the identification ID of the machine provided by the provider. + 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 @@ -480,12 +480,12 @@ spec: be interfacing with cluster-api as generic provider. type: string providerSpec: - description: ProviderSpec details Provider-specific configuration + description: providerSpec details Provider-specific configuration to use during node creation. properties: value: description: |- - Value is an inlined, serialized representation of the resource + 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. @@ -543,7 +543,7 @@ spec: format: int32 type: integer conditions: - description: Conditions defines the current state of the MachineSet + description: conditions defines the current state of the MachineSet items: description: Condition defines an observation of a Machine API resource operational state. @@ -568,16 +568,16 @@ spec: type: string severity: description: |- - Severity provides an explicit classification of Reason code, so the users or machines can immediately + 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. + description: status of the condition, one of True, False, Unknown. type: string type: description: |- - Type of condition in CamelCase or in foo.example.com/CamelCase. + 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 @@ -619,7 +619,7 @@ spec: format: int32 type: integer observedGeneration: - description: ObservedGeneration reflects the generation of the most + description: observedGeneration reflects the generation of the most recently observed MachineSet. format: int64 type: integer @@ -629,7 +629,7 @@ spec: format: int32 type: integer replicas: - description: Replicas is the most recently observed number of replicas. + description: replicas is the most recently observed number of replicas. format: int32 type: integer type: object diff --git a/machine/v1beta1/zz_generated.featuregated-crd-manifests/machinesets.machine.openshift.io/MachineAPIMigration.yaml b/machine/v1beta1/zz_generated.featuregated-crd-manifests/machinesets.machine.openshift.io/MachineAPIMigration.yaml index 4954d9fbba6..3616da68828 100644 --- a/machine/v1beta1/zz_generated.featuregated-crd-manifests/machinesets.machine.openshift.io/MachineAPIMigration.yaml +++ b/machine/v1beta1/zz_generated.featuregated-crd-manifests/machinesets.machine.openshift.io/MachineAPIMigration.yaml @@ -84,7 +84,7 @@ spec: type: string deletePolicy: description: |- - DeletePolicy defines the policy used to identify nodes to delete when downscaling. + deletePolicy defines the policy used to identify nodes to delete when downscaling. Defaults to "Random". Valid values are "Random, "Newest", "Oldest" enum: - Random @@ -93,21 +93,21 @@ spec: type: string minReadySeconds: description: |- - MinReadySeconds is the minimum number of seconds for which a newly created machine should be ready. + 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) format: int32 type: integer replicas: default: 1 description: |- - Replicas is the number of desired replicas. + replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. format: int32 type: integer selector: description: |- - Selector is a label query over machines that should match the replica count. + 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 @@ -157,7 +157,7 @@ spec: x-kubernetes-map-type: atomic template: description: |- - Template is the object that describes the machine that will be created if + template is the object that describes the machine that will be created if insufficient replicas are detected. properties: metadata: @@ -169,14 +169,14 @@ spec: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + 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 generateName: description: |- - GenerateName is an optional prefix, used by the server, to generate a unique + 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. @@ -203,7 +203,7 @@ spec: type: object name: description: |- - Name must be unique within a namespace. Is required when creating resources, although + 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. @@ -212,7 +212,7 @@ spec: type: string namespace: description: |- - Namespace defines the space within each name must be unique. An empty namespace is + 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. @@ -299,12 +299,12 @@ spec: type: string lifecycleHooks: description: |- - LifecycleHooks allow users to pause operations on the machine at + lifecycleHooks allow users to pause operations on the machine at certain predefined points within the machine lifecycle. properties: preDrain: description: |- - PreDrain hooks prevent the machine from being drained. + preDrain hooks prevent the machine from being drained. This also blocks further lifecycle events, such as termination. items: description: LifecycleHook represents a single instance @@ -312,7 +312,7 @@ spec: properties: name: description: |- - Name defines a unique name for the lifcycle hook. + 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. @@ -322,7 +322,7 @@ spec: type: string owner: description: |- - Owner defines the owner of the lifecycle hook. + 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) @@ -340,7 +340,7 @@ spec: x-kubernetes-list-type: map preTerminate: description: |- - PreTerminate hooks prevent the machine from being terminated. + preTerminate hooks prevent the machine from being terminated. PreTerminate hooks be actioned after the Machine has been drained. items: description: LifecycleHook represents a single instance @@ -348,7 +348,7 @@ spec: properties: name: description: |- - Name defines a unique name for the lifcycle hook. + 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. @@ -358,7 +358,7 @@ spec: type: string owner: description: |- - Owner defines the owner of the lifecycle hook. + 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) @@ -385,14 +385,14 @@ spec: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + 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 generateName: description: |- - GenerateName is an optional prefix, used by the server, to generate a unique + 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. @@ -419,7 +419,7 @@ spec: type: object name: description: |- - Name must be unique within a namespace. Is required when creating resources, although + 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. @@ -428,7 +428,7 @@ spec: type: string namespace: description: |- - Namespace defines the space within each name must be unique. An empty namespace is + 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. @@ -496,7 +496,7 @@ spec: type: object providerID: description: |- - ProviderID is the identification ID of the machine provided by the provider. + 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 @@ -508,12 +508,12 @@ spec: be interfacing with cluster-api as generic provider. type: string providerSpec: - description: ProviderSpec details Provider-specific configuration + description: providerSpec details Provider-specific configuration to use during node creation. properties: value: description: |- - Value is an inlined, serialized representation of the resource + 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. @@ -588,7 +588,7 @@ spec: format: int32 type: integer conditions: - description: Conditions defines the current state of the MachineSet + description: conditions defines the current state of the MachineSet items: description: Condition defines an observation of a Machine API resource operational state. @@ -613,16 +613,16 @@ spec: type: string severity: description: |- - Severity provides an explicit classification of Reason code, so the users or machines can immediately + 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. + description: status of the condition, one of True, False, Unknown. type: string type: description: |- - Type of condition in CamelCase or in foo.example.com/CamelCase. + 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 @@ -664,7 +664,7 @@ spec: format: int32 type: integer observedGeneration: - description: ObservedGeneration reflects the generation of the most + description: observedGeneration reflects the generation of the most recently observed MachineSet. format: int64 type: integer @@ -674,7 +674,7 @@ spec: format: int32 type: integer replicas: - description: Replicas is the most recently observed number of replicas. + description: replicas is the most recently observed number of replicas. format: int32 type: integer synchronizedGeneration: diff --git a/machine/v1beta1/zz_generated.swagger_doc_generated.go b/machine/v1beta1/zz_generated.swagger_doc_generated.go index 99540dde5e0..becb17ae179 100644 --- a/machine/v1beta1/zz_generated.swagger_doc_generated.go +++ b/machine/v1beta1/zz_generated.swagger_doc_generated.go @@ -13,24 +13,24 @@ package v1beta1 // AUTO-GENERATED FUNCTIONS START HERE var map_AWSMachineProviderConfig = map[string]string{ "": "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).", - "ami": "AMI is the reference to the AMI from which to create the machine instance.", - "instanceType": "InstanceType is the type of instance to create. Example: m4.xlarge", - "tags": "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.", - "iamInstanceProfile": "IAMInstanceProfile is a reference to an IAM role to assign to the instance", - "userDataSecret": "UserDataSecret contains a local reference to a secret that contains the UserData to apply to the instance", - "credentialsSecret": "CredentialsSecret is a reference to the secret with AWS credentials. Otherwise, defaults to permissions provided by attached IAM role where the actuator is running.", - "keyName": "KeyName is the name of the KeyPair to use for SSH", - "deviceIndex": "DeviceIndex is the index of the device on the instance for the network interface attachment. Defaults to 0.", - "publicIp": "PublicIP specifies whether the instance should get a public IP. If not present, it should use the default of its subnet.", - "networkInterfaceType": "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.", - "securityGroups": "SecurityGroups is an array of references to security groups that should be applied to the instance.", - "subnet": "Subnet is a reference to the subnet to use for this instance", - "placement": "Placement specifies where to create the instance in AWS", - "loadBalancers": "LoadBalancers is the set of load balancers to which the new instance should be added once it is created.", - "blockDevices": "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", - "spotMarketOptions": "SpotMarketOptions allows users to configure instances to be run using AWS Spot instances.", - "metadataServiceOptions": "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", - "placementGroupName": "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.", + "ami": "ami is the reference to the AMI from which to create the machine instance.", + "instanceType": "instanceType is the type of instance to create. Example: m4.xlarge", + "tags": "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.", + "iamInstanceProfile": "iamInstanceProfile is a reference to an IAM role to assign to the instance", + "userDataSecret": "userDataSecret contains a local reference to a secret that contains the UserData to apply to the instance", + "credentialsSecret": "credentialsSecret is a reference to the secret with AWS credentials. Otherwise, defaults to permissions provided by attached IAM role where the actuator is running.", + "keyName": "keyName is the name of the KeyPair to use for SSH", + "deviceIndex": "deviceIndex is the index of the device on the instance for the network interface attachment. Defaults to 0.", + "publicIp": "publicIp specifies whether the instance should get a public IP. If not present, it should use the default of its subnet.", + "networkInterfaceType": "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.", + "securityGroups": "securityGroups is an array of references to security groups that should be applied to the instance.", + "subnet": "subnet is a reference to the subnet to use for this instance", + "placement": "placement specifies where to create the instance in AWS", + "loadBalancers": "loadBalancers is the set of load balancers to which the new instance should be added once it is created.", + "blockDevices": "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", + "spotMarketOptions": "spotMarketOptions allows users to configure instances to be run using AWS Spot instances.", + "metadataServiceOptions": "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", + "placementGroupName": "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.", "placementGroupPartition": "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.", "capacityReservationId": "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-***", } @@ -49,9 +49,9 @@ func (AWSMachineProviderConfigList) SwaggerDoc() map[string]string { var map_AWSMachineProviderStatus = map[string]string{ "": "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).", - "instanceId": "InstanceID is the instance ID of the machine created in AWS", - "instanceState": "InstanceState is the state of the AWS instance for this machine", - "conditions": "Conditions is a set of conditions associated with the Machine to indicate errors or other status", + "instanceId": "instanceId is the instance ID of the machine created in AWS", + "instanceState": "instanceState is the state of the AWS instance for this machine", + "conditions": "conditions is a set of conditions associated with the Machine to indicate errors or other status", } func (AWSMachineProviderStatus) SwaggerDoc() map[string]string { @@ -60,9 +60,9 @@ func (AWSMachineProviderStatus) SwaggerDoc() map[string]string { var map_AWSResourceReference = map[string]string{ "": "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.", - "id": "ID of resource", - "arn": "ARN of resource", - "filters": "Filters is a set of filters used to identify a resource", + "id": "id of resource", + "arn": "arn of resource", + "filters": "filters is a set of filters used to identify a resource", } func (AWSResourceReference) SwaggerDoc() map[string]string { @@ -97,8 +97,8 @@ func (EBSBlockDeviceSpec) SwaggerDoc() map[string]string { var map_Filter = map[string]string{ "": "Filter is a filter used to identify an AWS resource", - "name": "Name of the filter. Filter names are case-sensitive.", - "values": "Values includes one or more filter values. Filter values are case-sensitive.", + "name": "name of the filter. Filter names are case-sensitive.", + "values": "values includes one or more filter values. Filter values are case-sensitive.", } func (Filter) SwaggerDoc() map[string]string { @@ -115,7 +115,7 @@ func (LoadBalancerReference) SwaggerDoc() map[string]string { var map_MetadataServiceOptions = map[string]string{ "": "MetadataServiceOptions defines the options available to a user when configuring Instance Metadata Service (IMDS) Options.", - "authentication": "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", + "authentication": "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", } func (MetadataServiceOptions) SwaggerDoc() map[string]string { @@ -124,9 +124,9 @@ func (MetadataServiceOptions) SwaggerDoc() map[string]string { var map_Placement = map[string]string{ "": "Placement indicates where to create the instance in AWS", - "region": "Region is the region to use to create the instance", - "availabilityZone": "AvailabilityZone is the availability zone of the instance", - "tenancy": "Tenancy indicates if instance should run on shared or single-tenant hardware. There are supported 3 options: default, dedicated and host.", + "region": "region is the region to use to create the instance", + "availabilityZone": "availabilityZone is the availability zone of the instance", + "tenancy": "tenancy indicates if instance should run on shared or single-tenant hardware. There are supported 3 options: default, dedicated and host.", } func (Placement) SwaggerDoc() map[string]string { @@ -144,8 +144,8 @@ func (SpotMarketOptions) SwaggerDoc() map[string]string { var map_TagSpecification = map[string]string{ "": "TagSpecification is the name/value pair for a tag", - "name": "Name of the tag", - "value": "Value of the tag", + "name": "name of the tag", + "value": "value of the tag", } func (TagSpecification) SwaggerDoc() map[string]string { @@ -154,8 +154,8 @@ func (TagSpecification) SwaggerDoc() map[string]string { var map_AzureBootDiagnostics = map[string]string{ "": "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.", - "storageAccountType": "StorageAccountType determines if the storage account for storing the diagnostics data should be provisioned by Azure (AzureManaged) or by the customer (CustomerManaged).", - "customerManaged": "CustomerManaged provides reference to the customer manager storage account.", + "storageAccountType": "storageAccountType determines if the storage account for storing the diagnostics data should be provisioned by Azure (AzureManaged) or by the customer (CustomerManaged).", + "customerManaged": "customerManaged provides reference to the customer manager storage account.", } func (AzureBootDiagnostics) SwaggerDoc() map[string]string { @@ -164,7 +164,7 @@ func (AzureBootDiagnostics) SwaggerDoc() map[string]string { var map_AzureCustomerManagedBootDiagnostics = map[string]string{ "": "AzureCustomerManagedBootDiagnostics provides reference to a customer managed storage account.", - "storageAccountURI": "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.", + "storageAccountURI": "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.", } func (AzureCustomerManagedBootDiagnostics) SwaggerDoc() map[string]string { @@ -182,33 +182,33 @@ func (AzureDiagnostics) SwaggerDoc() map[string]string { var map_AzureMachineProviderSpec = map[string]string{ "": "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).", - "userDataSecret": "UserDataSecret contains a local reference to a secret that contains the UserData to apply to the instance", - "credentialsSecret": "CredentialsSecret is a reference to the secret with Azure credentials.", - "location": "Location is the region to use to create the instance", - "vmSize": "VMSize is the size of the VM to create.", - "image": "Image is the OS image to use to create the instance.", - "osDisk": "OSDisk represents the parameters for creating the OS disk.", + "userDataSecret": "userDataSecret contains a local reference to a secret that contains the UserData to apply to the instance", + "credentialsSecret": "credentialsSecret is a reference to the secret with Azure credentials.", + "location": "location is the region to use to create the instance", + "vmSize": "vmSize is the size of the VM to create.", + "image": "image is the OS image to use to create the instance.", + "osDisk": "osDisk represents the parameters for creating the OS disk.", "dataDisks": "DataDisk specifies the parameters that are used to add one or more data disks to the machine.", - "sshPublicKey": "SSHPublicKey is the public key to use to SSH to the virtual machine.", - "publicIP": "PublicIP if true a public IP will be used", - "tags": "Tags is a list of tags to apply to the machine.", + "sshPublicKey": "sshPublicKey is the public key to use to SSH to the virtual machine.", + "publicIP": "publicIP if true a public IP will be used", + "tags": "tags is a list of tags to apply to the machine.", "securityGroup": "Network Security Group that needs to be attached to the machine's interface. No security group will be attached if empty.", "applicationSecurityGroups": "Application Security Groups that need to be attached to the machine's interface. No application security groups will be attached if zero-length.", - "subnet": "Subnet to use for this instance", - "publicLoadBalancer": "PublicLoadBalancer to use for this instance", + "subnet": "subnet to use for this instance", + "publicLoadBalancer": "publicLoadBalancer to use for this instance", "internalLoadBalancer": "InternalLoadBalancerName to use for this instance", - "natRule": "NatRule to set inbound NAT rule of the load balancer", - "managedIdentity": "ManagedIdentity to set managed identity name", - "vnet": "Vnet to set virtual network name", + "natRule": "natRule to set inbound NAT rule of the load balancer", + "managedIdentity": "managedIdentity to set managed identity name", + "vnet": "vnet to set virtual network name", "zone": "Availability Zone for the virtual machine. If nil, the virtual machine should be deployed to no zone", - "networkResourceGroup": "NetworkResourceGroup is the resource group for the virtual machine's network", - "resourceGroup": "ResourceGroup is the resource group for the virtual machine", - "spotVMOptions": "SpotVMOptions allows the ability to specify the Machine should use a Spot VM", - "securityProfile": "SecurityProfile specifies the Security profile settings for a virtual machine.", - "ultraSSDCapability": "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.", - "acceleratedNetworking": "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.", - "availabilitySet": "AvailabilitySet specifies the availability set to use for this instance. Availability set should be precreated, before using this field.", - "diagnostics": "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.", + "networkResourceGroup": "networkResourceGroup is the resource group for the virtual machine's network", + "resourceGroup": "resourceGroup is the resource group for the virtual machine", + "spotVMOptions": "spotVMOptions allows the ability to specify the Machine should use a Spot VM", + "securityProfile": "securityProfile specifies the Security profile settings for a virtual machine.", + "ultraSSDCapability": "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.", + "acceleratedNetworking": "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.", + "availabilitySet": "availabilitySet specifies the availability set to use for this instance. Availability set should be precreated, before using this field.", + "diagnostics": "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.", "capacityReservationGroupID": "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.", } @@ -218,9 +218,9 @@ func (AzureMachineProviderSpec) SwaggerDoc() map[string]string { var map_AzureMachineProviderStatus = map[string]string{ "": "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).", - "vmId": "VMID is the ID of the virtual machine created in Azure.", - "vmState": "VMState is the provisioning state of the Azure virtual machine.", - "conditions": "Conditions is a set of conditions associated with the Machine to indicate errors or other status.", + "vmId": "vmId is the ID of the virtual machine created in Azure.", + "vmState": "vmState is the provisioning state of the Azure virtual machine.", + "conditions": "conditions is a set of conditions associated with the Machine to indicate errors or other status.", } func (AzureMachineProviderStatus) SwaggerDoc() map[string]string { @@ -238,12 +238,12 @@ func (ConfidentialVM) SwaggerDoc() map[string]string { var map_DataDisk = map[string]string{ "": "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.", - "nameSuffix": "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.", - "diskSizeGB": "DiskSizeGB is the size in GB to assign to the data disk.", - "managedDisk": "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\".", - "lun": "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.", - "cachingType": "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.", - "deletionPolicy": "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.", + "nameSuffix": "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.", + "diskSizeGB": "diskSizeGB is the size in GB to assign to the data disk.", + "managedDisk": "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\".", + "lun": "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.", + "cachingType": "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.", + "deletionPolicy": "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.", } func (DataDisk) SwaggerDoc() map[string]string { @@ -280,12 +280,12 @@ func (DiskSettings) SwaggerDoc() map[string]string { var map_Image = map[string]string{ "": "Image is a mirror of azure sdk compute.ImageReference", - "publisher": "Publisher is the name of the organization that created the image", - "offer": "Offer specifies the name of a group of related images created by the publisher. For example, UbuntuServer, WindowsServer", - "sku": "SKU specifies an instance of an offer, such as a major release of a distribution. For example, 18.04-LTS, 2019-Datacenter", - "version": "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.", - "resourceID": "ResourceID specifies an image to use by ID", - "type": "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", + "publisher": "publisher is the name of the organization that created the image", + "offer": "offer specifies the name of a group of related images created by the publisher. For example, UbuntuServer, WindowsServer", + "sku": "sku specifies an instance of an offer, such as a major release of a distribution. For example, 18.04-LTS, 2019-Datacenter", + "version": "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.", + "resourceID": "resourceID specifies an image to use by ID", + "type": "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", } func (Image) SwaggerDoc() map[string]string { @@ -293,11 +293,11 @@ func (Image) SwaggerDoc() map[string]string { } var map_OSDisk = map[string]string{ - "osType": "OSType is the operating system type of the OS disk. Possible values include \"Linux\" and \"Windows\".", - "managedDisk": "ManagedDisk specifies the Managed Disk parameters for the OS disk.", - "diskSizeGB": "DiskSizeGB is the size in GB to assign to the data disk.", - "diskSettings": "DiskSettings describe ephemeral disk settings for the os disk.", - "cachingType": "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`.", + "osType": "osType is the operating system type of the OS disk. Possible values include \"Linux\" and \"Windows\".", + "managedDisk": "managedDisk specifies the Managed Disk parameters for the OS disk.", + "diskSizeGB": "diskSizeGB is the size in GB to assign to the data disk.", + "diskSettings": "diskSettings describe ephemeral disk settings for the os disk.", + "cachingType": "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`.", } func (OSDisk) SwaggerDoc() map[string]string { @@ -338,7 +338,7 @@ func (SecuritySettings) SwaggerDoc() map[string]string { var map_SpotVMOptions = map[string]string{ "": "SpotVMOptions defines the options relevant to running the Machine on Spot VMs", - "maxPrice": "MaxPrice defines the maximum price the user is willing to pay for Spot VM instances", + "maxPrice": "maxPrice defines the maximum price the user is willing to pay for Spot VM instances", } func (SpotVMOptions) SwaggerDoc() map[string]string { @@ -376,13 +376,13 @@ func (VMDiskSecurityProfile) SwaggerDoc() map[string]string { var map_GCPDisk = map[string]string{ "": "GCPDisk describes disks for GCP.", - "autoDelete": "AutoDelete indicates if the disk will be auto-deleted when the instance is deleted (default false).", - "boot": "Boot indicates if this is a boot disk (default false).", - "sizeGb": "SizeGB is the size of the disk (in GB).", - "type": "Type is the type of the disk (eg: pd-standard).", - "image": "Image is the source image to create this disk.", - "labels": "Labels list of labels to apply to the disk.", - "encryptionKey": "EncryptionKey is the customer-supplied encryption key of the disk.", + "autoDelete": "autoDelete indicates if the disk will be auto-deleted when the instance is deleted (default false).", + "boot": "boot indicates if this is a boot disk (default false).", + "sizeGb": "sizeGb is the size of the disk (in GB).", + "type": "type is the type of the disk (eg: pd-standard).", + "image": "image is the source image to create this disk.", + "labels": "labels list of labels to apply to the disk.", + "encryptionKey": "encryptionKey is the customer-supplied encryption key of the disk.", } func (GCPDisk) SwaggerDoc() map[string]string { @@ -392,7 +392,7 @@ func (GCPDisk) SwaggerDoc() map[string]string { var map_GCPEncryptionKeyReference = map[string]string{ "": "GCPEncryptionKeyReference describes the encryptionKey to use for a disk's encryption.", "kmsKey": "KMSKeyName is the reference KMS key, in the format", - "kmsKeyServiceAccount": "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.", + "kmsKeyServiceAccount": "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.", } func (GCPEncryptionKeyReference) SwaggerDoc() map[string]string { @@ -401,8 +401,8 @@ func (GCPEncryptionKeyReference) SwaggerDoc() map[string]string { var map_GCPGPUConfig = map[string]string{ "": "GCPGPUConfig describes type and count of GPUs attached to the instance on GCP.", - "count": "Count is the number of GPUs to be attached to an instance.", - "type": "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", + "count": "count is the number of GPUs to be attached to an instance.", + "type": "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", } func (GCPGPUConfig) SwaggerDoc() map[string]string { @@ -411,10 +411,10 @@ func (GCPGPUConfig) SwaggerDoc() map[string]string { var map_GCPKMSKeyReference = map[string]string{ "": "GCPKMSKeyReference gathers required fields for looking up a GCP KMS Key", - "name": "Name is the name of the customer managed encryption key to be used for the disk encryption.", - "keyRing": "KeyRing is the name of the KMS Key Ring which the KMS Key belongs to.", - "projectID": "ProjectID is the ID of the Project in which the KMS Key Ring exists. Defaults to the VM ProjectID if not set.", - "location": "Location is the GCP location in which the Key Ring exists.", + "name": "name is the name of the customer managed encryption key to be used for the disk encryption.", + "keyRing": "keyRing is the name of the KMS Key Ring which the KMS Key belongs to.", + "projectID": "projectID is the ID of the Project in which the KMS Key Ring exists. Defaults to the VM ProjectID if not set.", + "location": "location is the GCP location in which the Key Ring exists.", } func (GCPKMSKeyReference) SwaggerDoc() map[string]string { @@ -424,26 +424,26 @@ func (GCPKMSKeyReference) SwaggerDoc() map[string]string { var map_GCPMachineProviderSpec = map[string]string{ "": "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).", "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "userDataSecret": "UserDataSecret contains a local reference to a secret that contains the UserData to apply to the instance", - "credentialsSecret": "CredentialsSecret is a reference to the secret with GCP credentials.", - "canIPForward": "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.", - "deletionProtection": "DeletionProtection whether the resource should be protected against deletion.", - "disks": "Disks is a list of disks to be attached to the VM.", - "labels": "Labels list of labels to apply to the VM.", + "userDataSecret": "userDataSecret contains a local reference to a secret that contains the UserData to apply to the instance", + "credentialsSecret": "credentialsSecret is a reference to the secret with GCP credentials.", + "canIPForward": "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.", + "deletionProtection": "deletionProtection whether the resource should be protected against deletion.", + "disks": "disks is a list of disks to be attached to the VM.", + "labels": "labels list of labels to apply to the VM.", "gcpMetadata": "Metadata key/value pairs to apply to the VM.", - "networkInterfaces": "NetworkInterfaces is a list of network interfaces to be attached to the VM.", - "serviceAccounts": "ServiceAccounts is a list of GCP service accounts to be used by the VM.", - "tags": "Tags list of network tags to apply to the VM.", - "targetPools": "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", - "machineType": "MachineType is the machine type to use for the VM.", - "region": "Region is the region in which the GCP machine provider will create the VM.", - "zone": "Zone is the zone in which the GCP machine provider will create the VM.", - "projectID": "ProjectID is the project in which the GCP machine provider will create the VM.", - "gpus": "GPUs is a list of GPUs to be attached to the VM.", - "preemptible": "Preemptible indicates if created instance is preemptible.", - "onHostMaintenance": "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\".", - "restartPolicy": "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", - "shieldedInstanceConfig": "ShieldedInstanceConfig is the Shielded VM configuration for the VM", + "networkInterfaces": "networkInterfaces is a list of network interfaces to be attached to the VM.", + "serviceAccounts": "serviceAccounts is a list of GCP service accounts to be used by the VM.", + "tags": "tags list of network tags to apply to the VM.", + "targetPools": "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", + "machineType": "machineType is the machine type to use for the VM.", + "region": "region is the region in which the GCP machine provider will create the VM.", + "zone": "zone is the zone in which the GCP machine provider will create the VM.", + "projectID": "projectID is the project in which the GCP machine provider will create the VM.", + "gpus": "gpus is a list of GPUs to be attached to the VM.", + "preemptible": "preemptible indicates if created instance is preemptible.", + "onHostMaintenance": "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\".", + "restartPolicy": "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", + "shieldedInstanceConfig": "shieldedInstanceConfig is the Shielded VM configuration for the VM", "confidentialCompute": "confidentialCompute Defines whether the instance should have confidential compute enabled. If enabled 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 false.", "resourceManagerTags": "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.", } @@ -454,9 +454,9 @@ func (GCPMachineProviderSpec) SwaggerDoc() map[string]string { var map_GCPMachineProviderStatus = map[string]string{ "": "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).", - "instanceId": "InstanceID is the ID of the instance in GCP", - "instanceState": "InstanceState is the provisioning state of the GCP Instance.", - "conditions": "Conditions is a set of conditions associated with the Machine to indicate errors or other status", + "instanceId": "instanceId is the ID of the instance in GCP", + "instanceState": "instanceState is the provisioning state of the GCP Instance.", + "conditions": "conditions is a set of conditions associated with the Machine to indicate errors or other status", } func (GCPMachineProviderStatus) SwaggerDoc() map[string]string { @@ -465,8 +465,8 @@ func (GCPMachineProviderStatus) SwaggerDoc() map[string]string { var map_GCPMetadata = map[string]string{ "": "GCPMetadata describes metadata for GCP.", - "key": "Key is the metadata key.", - "value": "Value is the metadata value.", + "key": "key is the metadata key.", + "value": "value is the metadata value.", } func (GCPMetadata) SwaggerDoc() map[string]string { @@ -475,10 +475,10 @@ func (GCPMetadata) SwaggerDoc() map[string]string { var map_GCPNetworkInterface = map[string]string{ "": "GCPNetworkInterface describes network interfaces for GCP", - "publicIP": "PublicIP indicates if true a public IP will be used", - "network": "Network is the network name.", - "projectID": "ProjectID is the project in which the GCP machine provider will create the VM.", - "subnetwork": "Subnetwork is the subnetwork name.", + "publicIP": "publicIP indicates if true a public IP will be used", + "network": "network is the network name.", + "projectID": "projectID is the project in which the GCP machine provider will create the VM.", + "subnetwork": "subnetwork is the subnetwork name.", } func (GCPNetworkInterface) SwaggerDoc() map[string]string { @@ -487,8 +487,8 @@ func (GCPNetworkInterface) SwaggerDoc() map[string]string { var map_GCPServiceAccount = map[string]string{ "": "GCPServiceAccount describes service accounts for GCP.", - "email": "Email is the service account email.", - "scopes": "Scopes list of scopes to be assigned to the service account.", + "email": "email is the service account email.", + "scopes": "scopes list of scopes to be assigned to the service account.", } func (GCPServiceAccount) SwaggerDoc() map[string]string { @@ -519,8 +519,8 @@ func (ResourceManagerTag) SwaggerDoc() map[string]string { var map_LastOperation = map[string]string{ "": "LastOperation represents the detail of the last performed operation on the MachineObject.", - "description": "Description is the human-readable description of the last operation.", - "lastUpdated": "LastUpdated is the timestamp at which LastOperation API was last-updated.", + "description": "description is the human-readable description of the last operation.", + "lastUpdated": "lastUpdated is the timestamp at which LastOperation API was last-updated.", "state": "State is the current status of the last performed operation. E.g. Processing, Failed, Successful etc", "type": "Type is the type of operation which was last performed. E.g. Create, Delete, Update etc", } @@ -531,8 +531,8 @@ func (LastOperation) SwaggerDoc() map[string]string { var map_LifecycleHook = map[string]string{ "": "LifecycleHook represents a single instance of a lifecycle hook", - "name": "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.", - "owner": "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.", + "name": "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.", + "owner": "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.", } func (LifecycleHook) SwaggerDoc() map[string]string { @@ -541,8 +541,8 @@ func (LifecycleHook) SwaggerDoc() map[string]string { var map_LifecycleHooks = map[string]string{ "": "LifecycleHooks allow users to pause operations on the machine at certain prefedined points within the machine lifecycle.", - "preDrain": "PreDrain hooks prevent the machine from being drained. This also blocks further lifecycle events, such as termination.", - "preTerminate": "PreTerminate hooks prevent the machine from being terminated. PreTerminate hooks be actioned after the Machine has been drained.", + "preDrain": "preDrain hooks prevent the machine from being drained. This also blocks further lifecycle events, such as termination.", + "preTerminate": "preTerminate hooks prevent the machine from being terminated. PreTerminate hooks be actioned after the Machine has been drained.", } func (LifecycleHooks) SwaggerDoc() map[string]string { @@ -570,10 +570,10 @@ func (MachineList) SwaggerDoc() map[string]string { var map_MachineSpec = map[string]string{ "": "MachineSpec defines the desired state of Machine", "metadata": "ObjectMeta will autopopulate the Node created. Use this to indicate what labels, annotations, name prefix, etc., should be used when creating the Node.", - "lifecycleHooks": "LifecycleHooks allow users to pause operations on the machine at certain predefined points within the machine lifecycle.", + "lifecycleHooks": "lifecycleHooks allow users to pause operations on the machine at certain predefined points within the machine lifecycle.", "taints": "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", - "providerSpec": "ProviderSpec details Provider-specific configuration to use during node creation.", - "providerID": "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.", + "providerSpec": "providerSpec details Provider-specific configuration to use during node creation.", + "providerID": "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.", "authoritativeAPI": "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`.", } @@ -583,15 +583,15 @@ func (MachineSpec) SwaggerDoc() map[string]string { var map_MachineStatus = map[string]string{ "": "MachineStatus defines the observed state of Machine", - "nodeRef": "NodeRef will point to the corresponding Node if it exists.", - "lastUpdated": "LastUpdated identifies when this status was last observed.", - "errorReason": "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.", - "errorMessage": "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.", - "providerStatus": "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.", - "addresses": "Addresses is a list of addresses assigned to the machine. Queried from cloud provider, if available.", - "lastOperation": "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.", - "phase": "Phase represents the current phase of machine actuation. One of: Failed, Provisioning, Provisioned, Running, Deleting", - "conditions": "Conditions defines the current state of the Machine", + "nodeRef": "nodeRef will point to the corresponding Node if it exists.", + "lastUpdated": "lastUpdated identifies when this status was last observed.", + "errorReason": "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.", + "errorMessage": "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.", + "providerStatus": "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.", + "addresses": "addresses is a list of addresses assigned to the machine. Queried from cloud provider, if available.", + "lastOperation": "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.", + "phase": "phase represents the current phase of machine actuation. One of: Failed, Provisioning, Provisioned, Running, Deleting", + "conditions": "conditions defines the current state of the Machine", "authoritativeAPI": "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.", "synchronizedGeneration": "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.", } @@ -623,10 +623,10 @@ func (MachineHealthCheckList) SwaggerDoc() map[string]string { var map_MachineHealthCheckSpec = map[string]string{ "": "MachineHealthCheckSpec defines the desired state of MachineHealthCheck", "selector": "Label selector to match machines whose health will be exercised. Note: An empty selector will match all machines.", - "unhealthyConditions": "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.", + "unhealthyConditions": "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.", "maxUnhealthy": "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.", "nodeStartupTimeout": "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\".", - "remediationTemplate": "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.", + "remediationTemplate": "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.", } func (MachineHealthCheckSpec) SwaggerDoc() map[string]string { @@ -637,8 +637,8 @@ var map_MachineHealthCheckStatus = map[string]string{ "": "MachineHealthCheckStatus defines the observed state of MachineHealthCheck", "expectedMachines": "total number of machines counted by this machine health check", "currentHealthy": "total number of machines counted by this machine health check", - "remediationsAllowed": "RemediationsAllowed is the number of further remediations allowed by this machine health check before maxUnhealthy short circuiting will be applied", - "conditions": "Conditions defines the current state of the MachineHealthCheck", + "remediationsAllowed": "remediationsAllowed is the number of further remediations allowed by this machine health check before maxUnhealthy short circuiting will be applied", + "conditions": "conditions defines the current state of the MachineHealthCheck", } func (MachineHealthCheckStatus) SwaggerDoc() map[string]string { @@ -674,11 +674,11 @@ func (MachineSetList) SwaggerDoc() map[string]string { var map_MachineSetSpec = map[string]string{ "": "MachineSetSpec defines the desired state of MachineSet", - "replicas": "Replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1.", - "minReadySeconds": "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)", - "deletePolicy": "DeletePolicy defines the policy used to identify nodes to delete when downscaling. Defaults to \"Random\". Valid values are \"Random, \"Newest\", \"Oldest\"", - "selector": "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", - "template": "Template is the object that describes the machine that will be created if insufficient replicas are detected.", + "replicas": "replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1.", + "minReadySeconds": "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)", + "deletePolicy": "deletePolicy defines the policy used to identify nodes to delete when downscaling. Defaults to \"Random\". Valid values are \"Random, \"Newest\", \"Oldest\"", + "selector": "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", + "template": "template is the object that describes the machine that will be created if insufficient replicas are detected.", "authoritativeAPI": "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`.", } @@ -688,13 +688,13 @@ func (MachineSetSpec) SwaggerDoc() map[string]string { var map_MachineSetStatus = map[string]string{ "": "MachineSetStatus defines the observed state of MachineSet", - "replicas": "Replicas is the most recently observed number of replicas.", + "replicas": "replicas is the most recently observed number of replicas.", "fullyLabeledReplicas": "The number of replicas that have labels matching the labels of the machine template of the MachineSet.", "readyReplicas": "The number of ready replicas for this MachineSet. A machine is considered ready when the node has been created and is \"Ready\".", "availableReplicas": "The number of available replicas (ready for at least minReadySeconds) for this MachineSet.", - "observedGeneration": "ObservedGeneration reflects the generation of the most recently observed MachineSet.", + "observedGeneration": "observedGeneration reflects the generation of the most recently observed MachineSet.", "errorReason": "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.", - "conditions": "Conditions defines the current state of the MachineSet", + "conditions": "conditions defines the current state of the MachineSet", "authoritativeAPI": "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.", "synchronizedGeneration": "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.", } @@ -715,9 +715,9 @@ func (MachineTemplateSpec) SwaggerDoc() map[string]string { var map_Condition = map[string]string{ "": "Condition defines an observation of a Machine API resource operational state.", - "type": "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.", - "status": "Status of the condition, one of True, False, Unknown.", - "severity": "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": "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.", + "status": "status of the condition, one of True, False, Unknown.", + "severity": "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.", "lastTransitionTime": "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.", "reason": "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.", "message": "A human readable message indicating details about the transition. This field may be empty.", @@ -729,11 +729,11 @@ func (Condition) SwaggerDoc() map[string]string { var map_ObjectMeta = map[string]string{ "": "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.", - "name": "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", - "generateName": "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", - "namespace": "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", + "name": "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", + "generateName": "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", + "namespace": "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", "labels": "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", - "annotations": "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", + "annotations": "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", "ownerReferences": "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.", } @@ -743,7 +743,7 @@ func (ObjectMeta) SwaggerDoc() map[string]string { var map_ProviderSpec = map[string]string{ "": "ProviderSpec defines the configuration to use during node creation.", - "value": "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.", + "value": "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.", } func (ProviderSpec) SwaggerDoc() map[string]string { @@ -776,7 +776,7 @@ func (NetworkDeviceSpec) SwaggerDoc() map[string]string { var map_NetworkSpec = map[string]string{ "": "NetworkSpec defines the virtual machine's network configuration.", - "devices": "Devices defines the virtual machine's network interfaces.", + "devices": "devices defines the virtual machine's network interfaces.", } func (NetworkSpec) SwaggerDoc() map[string]string { @@ -785,18 +785,18 @@ func (NetworkSpec) SwaggerDoc() map[string]string { var map_VSphereMachineProviderSpec = map[string]string{ "": "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).", - "userDataSecret": "UserDataSecret contains a local reference to a secret that contains the UserData to apply to the instance", - "credentialsSecret": "CredentialsSecret is a reference to the secret with vSphere credentials.", - "template": "Template is the name, inventory path, or instance UUID of the template used to clone new machines.", - "workspace": "Workspace describes the workspace to use for the machine.", - "network": "Network is the network configuration for this machine's VM.", - "numCPUs": "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.", + "userDataSecret": "userDataSecret contains a local reference to a secret that contains the UserData to apply to the instance", + "credentialsSecret": "credentialsSecret is a reference to the secret with vSphere credentials.", + "template": "template is the name, inventory path, or instance UUID of the template used to clone new machines.", + "workspace": "workspace describes the workspace to use for the machine.", + "network": "network is the network configuration for this machine's VM.", + "numCPUs": "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.", "numCoresPerSocket": "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.", - "memoryMiB": "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.", - "diskGiB": "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.", + "memoryMiB": "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.", + "diskGiB": "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.", "tagIDs": "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.", - "snapshot": "Snapshot is the name of the snapshot from which the VM was cloned", - "cloneMode": "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.", + "snapshot": "snapshot is the name of the snapshot from which the VM was cloned", + "cloneMode": "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.", } func (VSphereMachineProviderSpec) SwaggerDoc() map[string]string { @@ -805,7 +805,7 @@ func (VSphereMachineProviderSpec) SwaggerDoc() map[string]string { var map_VSphereMachineProviderStatus = map[string]string{ "": "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).", - "instanceId": "InstanceID is the ID of the instance in VSphere", + "instanceId": "instanceId is the ID of the instance in VSphere", "instanceState": "InstanceState is the provisioning state of the VSphere Instance.", "conditions": "Conditions is a set of conditions associated with the Machine to indicate errors or other status", "taskRef": "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.", @@ -817,11 +817,11 @@ func (VSphereMachineProviderStatus) SwaggerDoc() map[string]string { var map_Workspace = map[string]string{ "": "WorkspaceConfig defines a workspace configuration for the vSphere cloud provider.", - "server": "Server is the IP address or FQDN of the vSphere endpoint.", - "datacenter": "Datacenter is the datacenter in which VMs are created/located.", - "folder": "Folder is the folder in which VMs are created/located.", - "datastore": "Datastore is the datastore in which VMs are created/located.", - "resourcePool": "ResourcePool is the resource pool in which VMs are created/located.", + "server": "server is the IP address or FQDN of the vSphere endpoint.", + "datacenter": "datacenter is the datacenter in which VMs are created/located.", + "folder": "folder is the folder in which VMs are created/located.", + "datastore": "datastore is the datastore in which VMs are created/located.", + "resourcePool": "resourcePool is the resource pool in which VMs are created/located.", "vmGroup": "vmGroup is the cluster vm group in which virtual machines will be added for vm host group based zonal.", } diff --git a/machineconfiguration/v1/types.go b/machineconfiguration/v1/types.go index 01644fcf778..b91132b509a 100644 --- a/machineconfiguration/v1/types.go +++ b/machineconfiguration/v1/types.go @@ -38,7 +38,7 @@ type ControllerConfig struct { // TODO(jkyros): inconsistent historical generation resulted in the controllerconfig CRD being // generated with all fields required, while everything else was generated with optional - // +kubebuilder:validation:Required + // +required Spec ControllerConfigSpec `json:"spec"` // +optional Status ControllerConfigStatus `json:"status"` @@ -47,11 +47,11 @@ type ControllerConfig struct { // ControllerConfigSpec is the spec for ControllerConfig resource. type ControllerConfigSpec struct { // clusterDNSIP is the cluster DNS IP address - // +kubebuilder:validation:Required + // +required ClusterDNSIP string `json:"clusterDNSIP"` // cloudProviderConfig is the configuration for the given cloud provider - // +kubebuilder:validation:Required + // +required CloudProviderConfig string `json:"cloudProviderConfig"` // platform is deprecated, use Infra.Status.PlatformStatus.Type instead @@ -65,21 +65,21 @@ type ControllerConfigSpec struct { // TODO: Use string for CA data // kubeAPIServerServingCAData managed Kubelet to API Server Cert... Rotated automatically - // +kubebuilder:validation:Required + // +required KubeAPIServerServingCAData []byte `json:"kubeAPIServerServingCAData"` // rootCAData specifies the root CA data - // +kubebuilder:validation:Required + // +required RootCAData []byte `json:"rootCAData"` // cloudProvider specifies the cloud provider CA data - // +kubebuilder:validation:Required + // +required // +nullable CloudProviderCAData []byte `json:"cloudProviderCAData"` // additionalTrustBundle is a certificate bundle that will be added to the nodes // trusted certificate store. - // +kubebuilder:validation:Required + // +required // +nullable AdditionalTrustBundle []byte `json:"additionalTrustBundle"` @@ -107,44 +107,44 @@ type ControllerConfigSpec struct { InternalRegistryPullSecret []byte `json:"internalRegistryPullSecret"` // images is map of images that are used by the controller to render templates under ./templates/ - // +kubebuilder:validation:Required + // +required Images map[string]string `json:"images"` - // BaseOSContainerImage is the new-format container image for operating system updates. - // +kubebuilder:validation:Required + // baseOSContainerImage is the new-format container image for operating system updates. + // +required BaseOSContainerImage string `json:"baseOSContainerImage"` - // BaseOSExtensionsContainerImage is the matching extensions container for the new-format container + // baseOSExtensionsContainerImage is the matching extensions container for the new-format container // +optional BaseOSExtensionsContainerImage string `json:"baseOSExtensionsContainerImage"` - // OSImageURL is the old-format container image that contains the OS update payload. + // osImageURL is the old-format container image that contains the OS update payload. // +optional OSImageURL string `json:"osImageURL"` // releaseImage is the image used when installing the cluster - // +kubebuilder:validation:Required + // +required ReleaseImage string `json:"releaseImage"` // proxy holds the current proxy configuration for the nodes - // +kubebuilder:validation:Required + // +required // +nullable Proxy *configv1.ProxyStatus `json:"proxy"` // infra holds the infrastructure details // +kubebuilder:validation:EmbeddedResource - // +kubebuilder:validation:Required + // +required // +nullable Infra *configv1.Infrastructure `json:"infra"` // dns holds the cluster dns details // +kubebuilder:validation:EmbeddedResource - // +kubebuilder:validation:Required + // +required // +nullable DNS *configv1.DNS `json:"dns"` // ipFamilies indicates the IP families in use by the cluster network - // +kubebuilder:validation:Required + // +required IPFamilies IPFamiliesType `json:"ipFamilies"` // networkType holds the type of network the cluster is using @@ -155,8 +155,8 @@ type ControllerConfigSpec struct { // +optional NetworkType string `json:"networkType,omitempty"` - // Network contains additional network related information - // +kubebuilder:validation:Required + // network contains additional network related information + // +required // +nullable Network *NetworkInfo `json:"network"` } @@ -164,10 +164,10 @@ type ControllerConfigSpec struct { // ImageRegistryBundle contains information for writing image registry certificates type ImageRegistryBundle struct { // file holds the name of the file where the bundle will be written to disk - // +kubebuilder:validation:Required + // +required File string `json:"file"` // data holds the contents of the bundle that will be written to the file location - // +kubebuilder:validation:Required + // +required Data []byte `json:"data"` } @@ -183,8 +183,8 @@ const ( // Network contains network related configuration type NetworkInfo struct { - // MTUMigration contains the MTU migration configuration. - // +kubebuilder:validation:Required + // mtuMigration contains the MTU migration configuration. + // +required // +nullable MTUMigration *configv1.MTUMigration `json:"mtuMigration"` } @@ -210,11 +210,11 @@ type ControllerConfigStatus struct { // ControllerCertificate contains info about a specific cert. type ControllerCertificate struct { // subject is the cert subject - // +kubebuilder:validation:Required + // +required Subject string `json:"subject"` // signer is the cert Issuer - // +kubebuilder:validation:Required + // +required Signer string `json:"signer"` // notBefore is the lower boundary for validity @@ -226,22 +226,22 @@ type ControllerCertificate struct { NotAfter *metav1.Time `json:"notAfter"` // bundleFile is the larger bundle a cert comes from - // +kubebuilder:validation:Required + // +required BundleFile string `json:"bundleFile"` } // ControllerConfigStatusCondition contains condition information for ControllerConfigStatus type ControllerConfigStatusCondition struct { // type specifies the state of the operator's reconciliation functionality. - // +kubebuilder:validation:Required + // +required Type ControllerConfigStatusConditionType `json:"type"` // status of the condition, one of True, False, Unknown. - // +kubebuilder:validation:Required + // +required Status corev1.ConditionStatus `json:"status"` // lastTransitionTime is the time of the last update to the current status object. - // +kubebuilder:validation:Required + // +required // +nullable LastTransitionTime metav1.Time `json:"lastTransitionTime"` @@ -308,17 +308,17 @@ type MachineConfig struct { // MachineConfigSpec is the spec for MachineConfig type MachineConfigSpec struct { - // OSImageURL specifies the remote location that will be used to + // osImageURL specifies the remote location that will be used to // fetch the OS. // +optional OSImageURL string `json:"osImageURL"` - // BaseOSExtensionsContainerImage specifies the remote location that will be used + // baseOSExtensionsContainerImage specifies the remote location that will be used // to fetch the extensions container matching a new-format OS image // +optional BaseOSExtensionsContainerImage string `json:"baseOSExtensionsContainerImage"` - // Config is a Ignition Config object. + // config is a Ignition Config object. // +optional Config runtime.RawExtension `json:"config"` @@ -383,7 +383,7 @@ type MachineConfigPool struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` - // +kubebuilder:validation:Required + // +required Spec MachineConfigPoolSpec `json:"spec"` // +optional Status MachineConfigPoolStatus `json:"status"` @@ -459,7 +459,7 @@ type PinnedImageSetRef struct { // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=253 // +kubebuilder:validation:Pattern=`^([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]{0,61}[a-zA-Z0-9])(\.([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]{0,61}[a-zA-Z0-9]))*$` - // +kubebuilder:validation:Required + // +required Name string `json:"name"` } @@ -520,26 +520,26 @@ type MachineConfigPoolStatus struct { // +kubebuilder:validation:XValidation:rule="self.availableMachineCount >= self.readyMachineCount", message="availableMachineCount must be greater than or equal to readyMachineCount" type PoolSynchronizerStatus struct { // poolSynchronizerType describes the type of the pool synchronizer. - // +kubebuilder:validation:Required + // +required PoolSynchronizerType PoolSynchronizerType `json:"poolSynchronizerType"` // machineCount is the number of machines that are managed by the node synchronizer. - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:Minimum=0 MachineCount int64 `json:"machineCount"` // updatedMachineCount is the number of machines that have been updated by the node synchronizer. - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:Minimum=0 UpdatedMachineCount int64 `json:"updatedMachineCount"` // readyMachineCount is the number of machines managed by the node synchronizer that are in a ready state. - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:Minimum=0 ReadyMachineCount int64 `json:"readyMachineCount"` // availableMachineCount is the number of machines managed by the node synchronizer which are available. - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:Minimum=0 AvailableMachineCount int64 `json:"availableMachineCount"` // unavailableMachineCount is the number of machines managed by the node synchronizer but are unavailable. - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:Minimum=0 UnavailableMachineCount int64 `json:"unavailableMachineCount"` // +kubebuilder:validation:XValidation:rule="self >= oldSelf || (self == 0 && oldSelf > 0)", message="observedGeneration must not move backwards except to zero" @@ -563,10 +563,10 @@ const ( // ceryExpiry contains the bundle name and the expiry date type CertExpiry struct { // bundle is the name of the bundle in which the subject certificate resides - // +kubebuilder:validation:Required + // +required Bundle string `json:"bundle"` // subject is the subject of the certificate - // +kubebuilder:validation:Required + // +required Subject string `json:"subject"` // expiry is the date after which the certificate will no longer be valid // +optional @@ -683,7 +683,7 @@ type KubeletConfig struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` - // +kubebuilder:validation:Required + // +required Spec KubeletConfigSpec `json:"spec"` // +optional Status KubeletConfigStatus `json:"status"` @@ -696,7 +696,7 @@ type KubeletConfigSpec struct { // +optional LogLevel *int32 `json:"logLevel,omitempty"` - // MachineConfigPoolSelector selects which pools the KubeletConfig shoud apply to. + // machineConfigPoolSelector selects which pools the KubeletConfig shoud apply to. // A nil selector will result in no pools being selected. // +optional MachineConfigPoolSelector *metav1.LabelSelector `json:"machineConfigPoolSelector,omitempty"` @@ -792,7 +792,7 @@ type ContainerRuntimeConfig struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` - // +kubebuilder:validation:Required + // +required Spec ContainerRuntimeConfigSpec `json:"spec"` // +optional Status ContainerRuntimeConfigStatus `json:"status"` @@ -800,12 +800,12 @@ type ContainerRuntimeConfig struct { // ContainerRuntimeConfigSpec defines the desired state of ContainerRuntimeConfig type ContainerRuntimeConfigSpec struct { - // MachineConfigPoolSelector selects which pools the ContainerRuntimeConfig shoud apply to. + // machineConfigPoolSelector selects which pools the ContainerRuntimeConfig shoud apply to. // A nil selector will result in no pools being selected. // +optional MachineConfigPoolSelector *metav1.LabelSelector `json:"machineConfigPoolSelector,omitempty"` - // +kubebuilder:validation:Required + // +required ContainerRuntimeConfig *ContainerRuntimeConfiguration `json:"containerRuntimeConfig,omitempty"` } diff --git a/machineconfiguration/v1/zz_generated.crd-manifests/0000_80_machine-config_01_containerruntimeconfigs.crd.yaml b/machineconfiguration/v1/zz_generated.crd-manifests/0000_80_machine-config_01_containerruntimeconfigs.crd.yaml index bd5297b1e60..71168270197 100644 --- a/machineconfiguration/v1/zz_generated.crd-manifests/0000_80_machine-config_01_containerruntimeconfigs.crd.yaml +++ b/machineconfiguration/v1/zz_generated.crd-manifests/0000_80_machine-config_01_containerruntimeconfigs.crd.yaml @@ -88,7 +88,7 @@ spec: type: object machineConfigPoolSelector: description: |- - MachineConfigPoolSelector selects which pools the ContainerRuntimeConfig shoud apply to. + machineConfigPoolSelector selects which pools the ContainerRuntimeConfig shoud apply to. A nil selector will result in no pools being selected. properties: matchExpressions: diff --git a/machineconfiguration/v1/zz_generated.crd-manifests/0000_80_machine-config_01_controllerconfigs-CustomNoUpgrade.crd.yaml b/machineconfiguration/v1/zz_generated.crd-manifests/0000_80_machine-config_01_controllerconfigs-CustomNoUpgrade.crd.yaml index 3b0f4fef8fc..4edf77e1e8a 100644 --- a/machineconfiguration/v1/zz_generated.crd-manifests/0000_80_machine-config_01_controllerconfigs-CustomNoUpgrade.crd.yaml +++ b/machineconfiguration/v1/zz_generated.crd-manifests/0000_80_machine-config_01_controllerconfigs-CustomNoUpgrade.crd.yaml @@ -56,11 +56,11 @@ spec: nullable: true type: string baseOSContainerImage: - description: BaseOSContainerImage is the new-format container image + description: baseOSContainerImage is the new-format container image for operating system updates. type: string baseOSExtensionsContainerImage: - description: BaseOSExtensionsContainerImage is the matching extensions + description: baseOSExtensionsContainerImage is the matching extensions container for the new-format container type: string cloudProviderCAData: @@ -337,7 +337,7 @@ spec: All the clients are expected to use the generated ConfigMap only. properties: key: - description: Key allows pointing to a specific key/value + description: key allows pointing to a specific key/value inside of the configmap. This is useful for logical file references. type: string @@ -350,11 +350,11 @@ spec: infrastructure provider. properties: alibabaCloud: - description: AlibabaCloud contains settings specific to + description: alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. type: object aws: - description: AWS contains settings specific to the Amazon + description: aws contains settings specific to the Amazon Web Services infrastructure provider. properties: serviceEndpoints: @@ -386,11 +386,11 @@ spec: x-kubernetes-list-type: atomic type: object azure: - description: Azure contains settings specific to the Azure + description: azure contains settings specific to the Azure infrastructure provider. type: object baremetal: - description: BareMetal contains settings specific to the + description: baremetal contains settings specific to the BareMetal platform. properties: apiServerInternalIPs: @@ -477,7 +477,7 @@ spec: - message: ingressIPs list is required once set rule: '!has(oldSelf.ingressIPs) || has(self.ingressIPs)' equinixMetal: - description: EquinixMetal contains settings specific to + description: equinixMetal contains settings specific to the Equinix Metal infrastructure provider. type: object external: @@ -488,7 +488,7 @@ spec: platformName: default: Unknown description: |- - PlatformName holds the arbitrary string representing the infrastructure provider name, expected to be set at the installation time. + 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 x-kubernetes-validations: @@ -496,19 +496,19 @@ spec: rule: oldSelf == 'Unknown' || self == oldSelf type: object gcp: - description: GCP contains settings specific to the Google + description: gcp contains settings specific to the Google Cloud Platform infrastructure provider. type: object ibmcloud: - description: IBMCloud contains settings specific to the + description: ibmcloud contains settings specific to the IBMCloud infrastructure provider. type: object kubevirt: - description: Kubevirt contains settings specific to the + description: kubevirt contains settings specific to the kubevirt infrastructure provider. type: object nutanix: - description: Nutanix contains settings specific to the + description: nutanix contains settings specific to the Nutanix infrastructure provider. properties: failureDomains: @@ -703,7 +703,7 @@ spec: - prismElements type: object openstack: - description: OpenStack contains settings specific to the + description: openstack contains settings specific to the OpenStack infrastructure provider. properties: apiServerInternalIPs: @@ -790,11 +790,11 @@ spec: - message: ingressIPs list is required once set rule: '!has(oldSelf.ingressIPs) || has(self.ingressIPs)' ovirt: - description: Ovirt contains settings specific to the oVirt + description: ovirt contains settings specific to the oVirt infrastructure provider. type: object powervs: - description: PowerVS contains settings specific to the + description: powervs contains settings specific to the IBM Power Systems Virtual Servers infrastructure provider. properties: serviceEndpoints: @@ -876,7 +876,7 @@ spec: - External type: string vsphere: - description: VSphere contains settings specific to the + description: vsphere contains settings specific to the VSphere infrastructure provider. properties: apiServerInternalIPs: @@ -958,7 +958,7 @@ spec: minLength: 1 type: string topology: - description: Topology describes a given failure + description: topology describes a given failure domain using vSphere constructs properties: computeCluster: @@ -1410,7 +1410,7 @@ spec: infrastructure provider. properties: alibabaCloud: - description: AlibabaCloud contains settings specific to + description: alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. properties: region: @@ -1454,7 +1454,7 @@ spec: - region type: object aws: - description: AWS contains settings specific to the Amazon + description: aws contains settings specific to the Amazon Web Services infrastructure provider. properties: cloudLoadBalancerConfig: @@ -1599,7 +1599,7 @@ spec: x-kubernetes-list-type: atomic serviceEndpoints: description: |- - ServiceEndpoints list contains custom endpoints which will override default + serviceEndpoints list contains custom endpoints which will override default service endpoint of AWS Services. There must be only one ServiceEndpoint for a service. items: @@ -1626,7 +1626,7 @@ spec: x-kubernetes-list-type: atomic type: object azure: - description: Azure contains settings specific to the Azure + description: azure contains settings specific to the Azure infrastructure provider. properties: armEndpoint: @@ -1702,7 +1702,7 @@ spec: rule: '!has(oldSelf.resourceTags) && !has(self.resourceTags) || has(oldSelf.resourceTags) && has(self.resourceTags)' baremetal: - description: BareMetal contains settings specific to the + description: baremetal contains settings specific to the BareMetal platform. properties: apiServerInternalIP: @@ -1812,7 +1812,7 @@ spec: type: string type: object equinixMetal: - description: EquinixMetal contains settings specific to + description: equinixMetal contains settings specific to the Equinix Metal infrastructure provider. properties: apiServerInternalIP: @@ -1829,7 +1829,7 @@ spec: type: string type: object external: - description: External contains settings specific to the + description: external contains settings specific to the generic External infrastructure provider. properties: cloudControllerManager: @@ -1869,7 +1869,7 @@ spec: removed once set rule: has(self.cloudControllerManager) == has(oldSelf.cloudControllerManager) gcp: - description: GCP contains settings specific to the Google + description: gcp contains settings specific to the Google Cloud Platform infrastructure provider. properties: cloudLoadBalancerConfig: @@ -2097,29 +2097,29 @@ spec: rule: '!has(oldSelf.resourceTags) && !has(self.resourceTags) || has(oldSelf.resourceTags) && has(self.resourceTags)' ibmcloud: - description: IBMCloud contains settings specific to the + description: ibmcloud contains settings specific to the IBMCloud infrastructure provider. properties: cisInstanceCRN: description: |- - CISInstanceCRN is the CRN of the Cloud Internet Services instance managing + 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 + 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 + description: location is where the cluster has been deployed type: string providerType: - description: ProviderType indicates the type of cluster + description: providerType indicates the type of cluster that was created type: string resourceGroupName: - description: ResourceGroupName is the Resource Group + description: resourceGroupName is the Resource Group for new IBMCloud resources created for the cluster. type: string serviceEndpoints: @@ -2174,7 +2174,7 @@ spec: x-kubernetes-list-type: map type: object kubevirt: - description: Kubevirt contains settings specific to the + description: kubevirt contains settings specific to the kubevirt infrastructure provider. properties: apiServerInternalIP: @@ -2191,7 +2191,7 @@ spec: type: string type: object nutanix: - description: Nutanix contains settings specific to the + description: nutanix contains settings specific to the Nutanix infrastructure provider. properties: apiServerInternalIP: @@ -2275,7 +2275,7 @@ spec: type: object type: object openstack: - description: OpenStack contains settings specific to the + description: openstack contains settings specific to the OpenStack infrastructure provider. properties: apiServerInternalIP: @@ -2390,7 +2390,7 @@ spec: type: string type: object ovirt: - description: Ovirt contains settings specific to the oVirt + description: ovirt contains settings specific to the oVirt infrastructure provider. properties: apiServerInternalIP: @@ -2479,17 +2479,17 @@ spec: type: string type: object powervs: - description: PowerVS contains settings specific to the + description: powervs contains settings specific to the Power Systems Virtual Servers infrastructure provider. properties: cisInstanceCRN: description: |- - CISInstanceCRN is the CRN of the Cloud Internet Services instance managing + 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 + dnsInstanceCRN is the CRN of the DNS Services instance managing the DNS zone for the cluster's base domain type: string region: @@ -2599,7 +2599,7 @@ spec: - External type: string vsphere: - description: VSphere contains settings specific to the + description: vsphere contains settings specific to the VSphere infrastructure provider. properties: apiServerInternalIP: @@ -2731,15 +2731,15 @@ spec: format: byte type: string network: - description: Network contains additional network related information + description: network contains additional network related information nullable: true properties: mtuMigration: - description: MTUMigration contains the MTU migration configuration. + description: mtuMigration contains the MTU migration configuration. nullable: true properties: machine: - description: Machine contains MTU migration configuration + description: machine contains MTU migration configuration for the machine's uplink. properties: from: @@ -2754,7 +2754,7 @@ spec: type: integer type: object network: - description: Network contains MTU migration configuration + description: network contains MTU migration configuration for the default network. properties: from: @@ -2781,7 +2781,7 @@ spec: regeneration if this changes. type: string osImageURL: - description: OSImageURL is the old-format container image that contains + description: osImageURL is the old-format container image that contains the OS update payload. type: string platform: diff --git a/machineconfiguration/v1/zz_generated.crd-manifests/0000_80_machine-config_01_controllerconfigs-Default.crd.yaml b/machineconfiguration/v1/zz_generated.crd-manifests/0000_80_machine-config_01_controllerconfigs-Default.crd.yaml index 56fc8e2128e..c7c6597981d 100644 --- a/machineconfiguration/v1/zz_generated.crd-manifests/0000_80_machine-config_01_controllerconfigs-Default.crd.yaml +++ b/machineconfiguration/v1/zz_generated.crd-manifests/0000_80_machine-config_01_controllerconfigs-Default.crd.yaml @@ -56,11 +56,11 @@ spec: nullable: true type: string baseOSContainerImage: - description: BaseOSContainerImage is the new-format container image + description: baseOSContainerImage is the new-format container image for operating system updates. type: string baseOSExtensionsContainerImage: - description: BaseOSExtensionsContainerImage is the matching extensions + description: baseOSExtensionsContainerImage is the matching extensions container for the new-format container type: string cloudProviderCAData: @@ -337,7 +337,7 @@ spec: All the clients are expected to use the generated ConfigMap only. properties: key: - description: Key allows pointing to a specific key/value + description: key allows pointing to a specific key/value inside of the configmap. This is useful for logical file references. type: string @@ -350,11 +350,11 @@ spec: infrastructure provider. properties: alibabaCloud: - description: AlibabaCloud contains settings specific to + description: alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. type: object aws: - description: AWS contains settings specific to the Amazon + description: aws contains settings specific to the Amazon Web Services infrastructure provider. properties: serviceEndpoints: @@ -386,11 +386,11 @@ spec: x-kubernetes-list-type: atomic type: object azure: - description: Azure contains settings specific to the Azure + description: azure contains settings specific to the Azure infrastructure provider. type: object baremetal: - description: BareMetal contains settings specific to the + description: baremetal contains settings specific to the BareMetal platform. properties: apiServerInternalIPs: @@ -477,7 +477,7 @@ spec: - message: ingressIPs list is required once set rule: '!has(oldSelf.ingressIPs) || has(self.ingressIPs)' equinixMetal: - description: EquinixMetal contains settings specific to + description: equinixMetal contains settings specific to the Equinix Metal infrastructure provider. type: object external: @@ -488,7 +488,7 @@ spec: platformName: default: Unknown description: |- - PlatformName holds the arbitrary string representing the infrastructure provider name, expected to be set at the installation time. + 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 x-kubernetes-validations: @@ -496,19 +496,19 @@ spec: rule: oldSelf == 'Unknown' || self == oldSelf type: object gcp: - description: GCP contains settings specific to the Google + description: gcp contains settings specific to the Google Cloud Platform infrastructure provider. type: object ibmcloud: - description: IBMCloud contains settings specific to the + description: ibmcloud contains settings specific to the IBMCloud infrastructure provider. type: object kubevirt: - description: Kubevirt contains settings specific to the + description: kubevirt contains settings specific to the kubevirt infrastructure provider. type: object nutanix: - description: Nutanix contains settings specific to the + description: nutanix contains settings specific to the Nutanix infrastructure provider. properties: failureDomains: @@ -698,7 +698,7 @@ spec: - prismElements type: object openstack: - description: OpenStack contains settings specific to the + description: openstack contains settings specific to the OpenStack infrastructure provider. properties: apiServerInternalIPs: @@ -785,11 +785,11 @@ spec: - message: ingressIPs list is required once set rule: '!has(oldSelf.ingressIPs) || has(self.ingressIPs)' ovirt: - description: Ovirt contains settings specific to the oVirt + description: ovirt contains settings specific to the oVirt infrastructure provider. type: object powervs: - description: PowerVS contains settings specific to the + description: powervs contains settings specific to the IBM Power Systems Virtual Servers infrastructure provider. properties: serviceEndpoints: @@ -871,7 +871,7 @@ spec: - External type: string vsphere: - description: VSphere contains settings specific to the + description: vsphere contains settings specific to the VSphere infrastructure provider. properties: apiServerInternalIPs: @@ -953,7 +953,7 @@ spec: minLength: 1 type: string topology: - description: Topology describes a given failure + description: topology describes a given failure domain using vSphere constructs properties: computeCluster: @@ -1405,7 +1405,7 @@ spec: infrastructure provider. properties: alibabaCloud: - description: AlibabaCloud contains settings specific to + description: alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. properties: region: @@ -1449,7 +1449,7 @@ spec: - region type: object aws: - description: AWS contains settings specific to the Amazon + description: aws contains settings specific to the Amazon Web Services infrastructure provider. properties: region: @@ -1490,7 +1490,7 @@ spec: x-kubernetes-list-type: atomic serviceEndpoints: description: |- - ServiceEndpoints list contains custom endpoints which will override default + serviceEndpoints list contains custom endpoints which will override default service endpoint of AWS Services. There must be only one ServiceEndpoint for a service. items: @@ -1517,7 +1517,7 @@ spec: x-kubernetes-list-type: atomic type: object azure: - description: Azure contains settings specific to the Azure + description: azure contains settings specific to the Azure infrastructure provider. properties: armEndpoint: @@ -1593,7 +1593,7 @@ spec: rule: '!has(oldSelf.resourceTags) && !has(self.resourceTags) || has(oldSelf.resourceTags) && has(self.resourceTags)' baremetal: - description: BareMetal contains settings specific to the + description: baremetal contains settings specific to the BareMetal platform. properties: apiServerInternalIP: @@ -1703,7 +1703,7 @@ spec: type: string type: object equinixMetal: - description: EquinixMetal contains settings specific to + description: equinixMetal contains settings specific to the Equinix Metal infrastructure provider. properties: apiServerInternalIP: @@ -1720,7 +1720,7 @@ spec: type: string type: object external: - description: External contains settings specific to the + description: external contains settings specific to the generic External infrastructure provider. properties: cloudControllerManager: @@ -1760,7 +1760,7 @@ spec: removed once set rule: has(self.cloudControllerManager) == has(oldSelf.cloudControllerManager) gcp: - description: GCP contains settings specific to the Google + description: gcp contains settings specific to the Google Cloud Platform infrastructure provider. properties: projectID: @@ -1884,29 +1884,29 @@ spec: rule: '!has(oldSelf.resourceTags) && !has(self.resourceTags) || has(oldSelf.resourceTags) && has(self.resourceTags)' ibmcloud: - description: IBMCloud contains settings specific to the + description: ibmcloud contains settings specific to the IBMCloud infrastructure provider. properties: cisInstanceCRN: description: |- - CISInstanceCRN is the CRN of the Cloud Internet Services instance managing + 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 + 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 + description: location is where the cluster has been deployed type: string providerType: - description: ProviderType indicates the type of cluster + description: providerType indicates the type of cluster that was created type: string resourceGroupName: - description: ResourceGroupName is the Resource Group + description: resourceGroupName is the Resource Group for new IBMCloud resources created for the cluster. type: string serviceEndpoints: @@ -1961,7 +1961,7 @@ spec: x-kubernetes-list-type: map type: object kubevirt: - description: Kubevirt contains settings specific to the + description: kubevirt contains settings specific to the kubevirt infrastructure provider. properties: apiServerInternalIP: @@ -1978,7 +1978,7 @@ spec: type: string type: object nutanix: - description: Nutanix contains settings specific to the + description: nutanix contains settings specific to the Nutanix infrastructure provider. properties: apiServerInternalIP: @@ -2062,7 +2062,7 @@ spec: type: object type: object openstack: - description: OpenStack contains settings specific to the + description: openstack contains settings specific to the OpenStack infrastructure provider. properties: apiServerInternalIP: @@ -2177,7 +2177,7 @@ spec: type: string type: object ovirt: - description: Ovirt contains settings specific to the oVirt + description: ovirt contains settings specific to the oVirt infrastructure provider. properties: apiServerInternalIP: @@ -2266,17 +2266,17 @@ spec: type: string type: object powervs: - description: PowerVS contains settings specific to the + description: powervs contains settings specific to the Power Systems Virtual Servers infrastructure provider. properties: cisInstanceCRN: description: |- - CISInstanceCRN is the CRN of the Cloud Internet Services instance managing + 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 + dnsInstanceCRN is the CRN of the DNS Services instance managing the DNS zone for the cluster's base domain type: string region: @@ -2386,7 +2386,7 @@ spec: - External type: string vsphere: - description: VSphere contains settings specific to the + description: vsphere contains settings specific to the VSphere infrastructure provider. properties: apiServerInternalIP: @@ -2518,15 +2518,15 @@ spec: format: byte type: string network: - description: Network contains additional network related information + description: network contains additional network related information nullable: true properties: mtuMigration: - description: MTUMigration contains the MTU migration configuration. + description: mtuMigration contains the MTU migration configuration. nullable: true properties: machine: - description: Machine contains MTU migration configuration + description: machine contains MTU migration configuration for the machine's uplink. properties: from: @@ -2541,7 +2541,7 @@ spec: type: integer type: object network: - description: Network contains MTU migration configuration + description: network contains MTU migration configuration for the default network. properties: from: @@ -2568,7 +2568,7 @@ spec: regeneration if this changes. type: string osImageURL: - description: OSImageURL is the old-format container image that contains + description: osImageURL is the old-format container image that contains the OS update payload. type: string platform: diff --git a/machineconfiguration/v1/zz_generated.crd-manifests/0000_80_machine-config_01_controllerconfigs-DevPreviewNoUpgrade.crd.yaml b/machineconfiguration/v1/zz_generated.crd-manifests/0000_80_machine-config_01_controllerconfigs-DevPreviewNoUpgrade.crd.yaml index a4690058e36..6f66684e2db 100644 --- a/machineconfiguration/v1/zz_generated.crd-manifests/0000_80_machine-config_01_controllerconfigs-DevPreviewNoUpgrade.crd.yaml +++ b/machineconfiguration/v1/zz_generated.crd-manifests/0000_80_machine-config_01_controllerconfigs-DevPreviewNoUpgrade.crd.yaml @@ -56,11 +56,11 @@ spec: nullable: true type: string baseOSContainerImage: - description: BaseOSContainerImage is the new-format container image + description: baseOSContainerImage is the new-format container image for operating system updates. type: string baseOSExtensionsContainerImage: - description: BaseOSExtensionsContainerImage is the matching extensions + description: baseOSExtensionsContainerImage is the matching extensions container for the new-format container type: string cloudProviderCAData: @@ -337,7 +337,7 @@ spec: All the clients are expected to use the generated ConfigMap only. properties: key: - description: Key allows pointing to a specific key/value + description: key allows pointing to a specific key/value inside of the configmap. This is useful for logical file references. type: string @@ -350,11 +350,11 @@ spec: infrastructure provider. properties: alibabaCloud: - description: AlibabaCloud contains settings specific to + description: alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. type: object aws: - description: AWS contains settings specific to the Amazon + description: aws contains settings specific to the Amazon Web Services infrastructure provider. properties: serviceEndpoints: @@ -386,11 +386,11 @@ spec: x-kubernetes-list-type: atomic type: object azure: - description: Azure contains settings specific to the Azure + description: azure contains settings specific to the Azure infrastructure provider. type: object baremetal: - description: BareMetal contains settings specific to the + description: baremetal contains settings specific to the BareMetal platform. properties: apiServerInternalIPs: @@ -477,7 +477,7 @@ spec: - message: ingressIPs list is required once set rule: '!has(oldSelf.ingressIPs) || has(self.ingressIPs)' equinixMetal: - description: EquinixMetal contains settings specific to + description: equinixMetal contains settings specific to the Equinix Metal infrastructure provider. type: object external: @@ -488,7 +488,7 @@ spec: platformName: default: Unknown description: |- - PlatformName holds the arbitrary string representing the infrastructure provider name, expected to be set at the installation time. + 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 x-kubernetes-validations: @@ -496,19 +496,19 @@ spec: rule: oldSelf == 'Unknown' || self == oldSelf type: object gcp: - description: GCP contains settings specific to the Google + description: gcp contains settings specific to the Google Cloud Platform infrastructure provider. type: object ibmcloud: - description: IBMCloud contains settings specific to the + description: ibmcloud contains settings specific to the IBMCloud infrastructure provider. type: object kubevirt: - description: Kubevirt contains settings specific to the + description: kubevirt contains settings specific to the kubevirt infrastructure provider. type: object nutanix: - description: Nutanix contains settings specific to the + description: nutanix contains settings specific to the Nutanix infrastructure provider. properties: failureDomains: @@ -703,7 +703,7 @@ spec: - prismElements type: object openstack: - description: OpenStack contains settings specific to the + description: openstack contains settings specific to the OpenStack infrastructure provider. properties: apiServerInternalIPs: @@ -790,11 +790,11 @@ spec: - message: ingressIPs list is required once set rule: '!has(oldSelf.ingressIPs) || has(self.ingressIPs)' ovirt: - description: Ovirt contains settings specific to the oVirt + description: ovirt contains settings specific to the oVirt infrastructure provider. type: object powervs: - description: PowerVS contains settings specific to the + description: powervs contains settings specific to the IBM Power Systems Virtual Servers infrastructure provider. properties: serviceEndpoints: @@ -876,7 +876,7 @@ spec: - External type: string vsphere: - description: VSphere contains settings specific to the + description: vsphere contains settings specific to the VSphere infrastructure provider. properties: apiServerInternalIPs: @@ -958,7 +958,7 @@ spec: minLength: 1 type: string topology: - description: Topology describes a given failure + description: topology describes a given failure domain using vSphere constructs properties: computeCluster: @@ -1410,7 +1410,7 @@ spec: infrastructure provider. properties: alibabaCloud: - description: AlibabaCloud contains settings specific to + description: alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. properties: region: @@ -1454,7 +1454,7 @@ spec: - region type: object aws: - description: AWS contains settings specific to the Amazon + description: aws contains settings specific to the Amazon Web Services infrastructure provider. properties: cloudLoadBalancerConfig: @@ -1599,7 +1599,7 @@ spec: x-kubernetes-list-type: atomic serviceEndpoints: description: |- - ServiceEndpoints list contains custom endpoints which will override default + serviceEndpoints list contains custom endpoints which will override default service endpoint of AWS Services. There must be only one ServiceEndpoint for a service. items: @@ -1626,7 +1626,7 @@ spec: x-kubernetes-list-type: atomic type: object azure: - description: Azure contains settings specific to the Azure + description: azure contains settings specific to the Azure infrastructure provider. properties: armEndpoint: @@ -1702,7 +1702,7 @@ spec: rule: '!has(oldSelf.resourceTags) && !has(self.resourceTags) || has(oldSelf.resourceTags) && has(self.resourceTags)' baremetal: - description: BareMetal contains settings specific to the + description: baremetal contains settings specific to the BareMetal platform. properties: apiServerInternalIP: @@ -1812,7 +1812,7 @@ spec: type: string type: object equinixMetal: - description: EquinixMetal contains settings specific to + description: equinixMetal contains settings specific to the Equinix Metal infrastructure provider. properties: apiServerInternalIP: @@ -1829,7 +1829,7 @@ spec: type: string type: object external: - description: External contains settings specific to the + description: external contains settings specific to the generic External infrastructure provider. properties: cloudControllerManager: @@ -1869,7 +1869,7 @@ spec: removed once set rule: has(self.cloudControllerManager) == has(oldSelf.cloudControllerManager) gcp: - description: GCP contains settings specific to the Google + description: gcp contains settings specific to the Google Cloud Platform infrastructure provider. properties: cloudLoadBalancerConfig: @@ -2097,29 +2097,29 @@ spec: rule: '!has(oldSelf.resourceTags) && !has(self.resourceTags) || has(oldSelf.resourceTags) && has(self.resourceTags)' ibmcloud: - description: IBMCloud contains settings specific to the + description: ibmcloud contains settings specific to the IBMCloud infrastructure provider. properties: cisInstanceCRN: description: |- - CISInstanceCRN is the CRN of the Cloud Internet Services instance managing + 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 + 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 + description: location is where the cluster has been deployed type: string providerType: - description: ProviderType indicates the type of cluster + description: providerType indicates the type of cluster that was created type: string resourceGroupName: - description: ResourceGroupName is the Resource Group + description: resourceGroupName is the Resource Group for new IBMCloud resources created for the cluster. type: string serviceEndpoints: @@ -2174,7 +2174,7 @@ spec: x-kubernetes-list-type: map type: object kubevirt: - description: Kubevirt contains settings specific to the + description: kubevirt contains settings specific to the kubevirt infrastructure provider. properties: apiServerInternalIP: @@ -2191,7 +2191,7 @@ spec: type: string type: object nutanix: - description: Nutanix contains settings specific to the + description: nutanix contains settings specific to the Nutanix infrastructure provider. properties: apiServerInternalIP: @@ -2275,7 +2275,7 @@ spec: type: object type: object openstack: - description: OpenStack contains settings specific to the + description: openstack contains settings specific to the OpenStack infrastructure provider. properties: apiServerInternalIP: @@ -2390,7 +2390,7 @@ spec: type: string type: object ovirt: - description: Ovirt contains settings specific to the oVirt + description: ovirt contains settings specific to the oVirt infrastructure provider. properties: apiServerInternalIP: @@ -2479,17 +2479,17 @@ spec: type: string type: object powervs: - description: PowerVS contains settings specific to the + description: powervs contains settings specific to the Power Systems Virtual Servers infrastructure provider. properties: cisInstanceCRN: description: |- - CISInstanceCRN is the CRN of the Cloud Internet Services instance managing + 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 + dnsInstanceCRN is the CRN of the DNS Services instance managing the DNS zone for the cluster's base domain type: string region: @@ -2599,7 +2599,7 @@ spec: - External type: string vsphere: - description: VSphere contains settings specific to the + description: vsphere contains settings specific to the VSphere infrastructure provider. properties: apiServerInternalIP: @@ -2731,15 +2731,15 @@ spec: format: byte type: string network: - description: Network contains additional network related information + description: network contains additional network related information nullable: true properties: mtuMigration: - description: MTUMigration contains the MTU migration configuration. + description: mtuMigration contains the MTU migration configuration. nullable: true properties: machine: - description: Machine contains MTU migration configuration + description: machine contains MTU migration configuration for the machine's uplink. properties: from: @@ -2754,7 +2754,7 @@ spec: type: integer type: object network: - description: Network contains MTU migration configuration + description: network contains MTU migration configuration for the default network. properties: from: @@ -2781,7 +2781,7 @@ spec: regeneration if this changes. type: string osImageURL: - description: OSImageURL is the old-format container image that contains + description: osImageURL is the old-format container image that contains the OS update payload. type: string platform: diff --git a/machineconfiguration/v1/zz_generated.crd-manifests/0000_80_machine-config_01_controllerconfigs-TechPreviewNoUpgrade.crd.yaml b/machineconfiguration/v1/zz_generated.crd-manifests/0000_80_machine-config_01_controllerconfigs-TechPreviewNoUpgrade.crd.yaml index b9366fe0373..a935a973d61 100644 --- a/machineconfiguration/v1/zz_generated.crd-manifests/0000_80_machine-config_01_controllerconfigs-TechPreviewNoUpgrade.crd.yaml +++ b/machineconfiguration/v1/zz_generated.crd-manifests/0000_80_machine-config_01_controllerconfigs-TechPreviewNoUpgrade.crd.yaml @@ -56,11 +56,11 @@ spec: nullable: true type: string baseOSContainerImage: - description: BaseOSContainerImage is the new-format container image + description: baseOSContainerImage is the new-format container image for operating system updates. type: string baseOSExtensionsContainerImage: - description: BaseOSExtensionsContainerImage is the matching extensions + description: baseOSExtensionsContainerImage is the matching extensions container for the new-format container type: string cloudProviderCAData: @@ -337,7 +337,7 @@ spec: All the clients are expected to use the generated ConfigMap only. properties: key: - description: Key allows pointing to a specific key/value + description: key allows pointing to a specific key/value inside of the configmap. This is useful for logical file references. type: string @@ -350,11 +350,11 @@ spec: infrastructure provider. properties: alibabaCloud: - description: AlibabaCloud contains settings specific to + description: alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. type: object aws: - description: AWS contains settings specific to the Amazon + description: aws contains settings specific to the Amazon Web Services infrastructure provider. properties: serviceEndpoints: @@ -386,11 +386,11 @@ spec: x-kubernetes-list-type: atomic type: object azure: - description: Azure contains settings specific to the Azure + description: azure contains settings specific to the Azure infrastructure provider. type: object baremetal: - description: BareMetal contains settings specific to the + description: baremetal contains settings specific to the BareMetal platform. properties: apiServerInternalIPs: @@ -477,7 +477,7 @@ spec: - message: ingressIPs list is required once set rule: '!has(oldSelf.ingressIPs) || has(self.ingressIPs)' equinixMetal: - description: EquinixMetal contains settings specific to + description: equinixMetal contains settings specific to the Equinix Metal infrastructure provider. type: object external: @@ -488,7 +488,7 @@ spec: platformName: default: Unknown description: |- - PlatformName holds the arbitrary string representing the infrastructure provider name, expected to be set at the installation time. + 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 x-kubernetes-validations: @@ -496,19 +496,19 @@ spec: rule: oldSelf == 'Unknown' || self == oldSelf type: object gcp: - description: GCP contains settings specific to the Google + description: gcp contains settings specific to the Google Cloud Platform infrastructure provider. type: object ibmcloud: - description: IBMCloud contains settings specific to the + description: ibmcloud contains settings specific to the IBMCloud infrastructure provider. type: object kubevirt: - description: Kubevirt contains settings specific to the + description: kubevirt contains settings specific to the kubevirt infrastructure provider. type: object nutanix: - description: Nutanix contains settings specific to the + description: nutanix contains settings specific to the Nutanix infrastructure provider. properties: failureDomains: @@ -703,7 +703,7 @@ spec: - prismElements type: object openstack: - description: OpenStack contains settings specific to the + description: openstack contains settings specific to the OpenStack infrastructure provider. properties: apiServerInternalIPs: @@ -790,11 +790,11 @@ spec: - message: ingressIPs list is required once set rule: '!has(oldSelf.ingressIPs) || has(self.ingressIPs)' ovirt: - description: Ovirt contains settings specific to the oVirt + description: ovirt contains settings specific to the oVirt infrastructure provider. type: object powervs: - description: PowerVS contains settings specific to the + description: powervs contains settings specific to the IBM Power Systems Virtual Servers infrastructure provider. properties: serviceEndpoints: @@ -876,7 +876,7 @@ spec: - External type: string vsphere: - description: VSphere contains settings specific to the + description: vsphere contains settings specific to the VSphere infrastructure provider. properties: apiServerInternalIPs: @@ -958,7 +958,7 @@ spec: minLength: 1 type: string topology: - description: Topology describes a given failure + description: topology describes a given failure domain using vSphere constructs properties: computeCluster: @@ -1410,7 +1410,7 @@ spec: infrastructure provider. properties: alibabaCloud: - description: AlibabaCloud contains settings specific to + description: alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. properties: region: @@ -1454,7 +1454,7 @@ spec: - region type: object aws: - description: AWS contains settings specific to the Amazon + description: aws contains settings specific to the Amazon Web Services infrastructure provider. properties: cloudLoadBalancerConfig: @@ -1599,7 +1599,7 @@ spec: x-kubernetes-list-type: atomic serviceEndpoints: description: |- - ServiceEndpoints list contains custom endpoints which will override default + serviceEndpoints list contains custom endpoints which will override default service endpoint of AWS Services. There must be only one ServiceEndpoint for a service. items: @@ -1626,7 +1626,7 @@ spec: x-kubernetes-list-type: atomic type: object azure: - description: Azure contains settings specific to the Azure + description: azure contains settings specific to the Azure infrastructure provider. properties: armEndpoint: @@ -1702,7 +1702,7 @@ spec: rule: '!has(oldSelf.resourceTags) && !has(self.resourceTags) || has(oldSelf.resourceTags) && has(self.resourceTags)' baremetal: - description: BareMetal contains settings specific to the + description: baremetal contains settings specific to the BareMetal platform. properties: apiServerInternalIP: @@ -1812,7 +1812,7 @@ spec: type: string type: object equinixMetal: - description: EquinixMetal contains settings specific to + description: equinixMetal contains settings specific to the Equinix Metal infrastructure provider. properties: apiServerInternalIP: @@ -1829,7 +1829,7 @@ spec: type: string type: object external: - description: External contains settings specific to the + description: external contains settings specific to the generic External infrastructure provider. properties: cloudControllerManager: @@ -1869,7 +1869,7 @@ spec: removed once set rule: has(self.cloudControllerManager) == has(oldSelf.cloudControllerManager) gcp: - description: GCP contains settings specific to the Google + description: gcp contains settings specific to the Google Cloud Platform infrastructure provider. properties: cloudLoadBalancerConfig: @@ -2097,29 +2097,29 @@ spec: rule: '!has(oldSelf.resourceTags) && !has(self.resourceTags) || has(oldSelf.resourceTags) && has(self.resourceTags)' ibmcloud: - description: IBMCloud contains settings specific to the + description: ibmcloud contains settings specific to the IBMCloud infrastructure provider. properties: cisInstanceCRN: description: |- - CISInstanceCRN is the CRN of the Cloud Internet Services instance managing + 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 + 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 + description: location is where the cluster has been deployed type: string providerType: - description: ProviderType indicates the type of cluster + description: providerType indicates the type of cluster that was created type: string resourceGroupName: - description: ResourceGroupName is the Resource Group + description: resourceGroupName is the Resource Group for new IBMCloud resources created for the cluster. type: string serviceEndpoints: @@ -2174,7 +2174,7 @@ spec: x-kubernetes-list-type: map type: object kubevirt: - description: Kubevirt contains settings specific to the + description: kubevirt contains settings specific to the kubevirt infrastructure provider. properties: apiServerInternalIP: @@ -2191,7 +2191,7 @@ spec: type: string type: object nutanix: - description: Nutanix contains settings specific to the + description: nutanix contains settings specific to the Nutanix infrastructure provider. properties: apiServerInternalIP: @@ -2275,7 +2275,7 @@ spec: type: object type: object openstack: - description: OpenStack contains settings specific to the + description: openstack contains settings specific to the OpenStack infrastructure provider. properties: apiServerInternalIP: @@ -2390,7 +2390,7 @@ spec: type: string type: object ovirt: - description: Ovirt contains settings specific to the oVirt + description: ovirt contains settings specific to the oVirt infrastructure provider. properties: apiServerInternalIP: @@ -2479,17 +2479,17 @@ spec: type: string type: object powervs: - description: PowerVS contains settings specific to the + description: powervs contains settings specific to the Power Systems Virtual Servers infrastructure provider. properties: cisInstanceCRN: description: |- - CISInstanceCRN is the CRN of the Cloud Internet Services instance managing + 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 + dnsInstanceCRN is the CRN of the DNS Services instance managing the DNS zone for the cluster's base domain type: string region: @@ -2599,7 +2599,7 @@ spec: - External type: string vsphere: - description: VSphere contains settings specific to the + description: vsphere contains settings specific to the VSphere infrastructure provider. properties: apiServerInternalIP: @@ -2731,15 +2731,15 @@ spec: format: byte type: string network: - description: Network contains additional network related information + description: network contains additional network related information nullable: true properties: mtuMigration: - description: MTUMigration contains the MTU migration configuration. + description: mtuMigration contains the MTU migration configuration. nullable: true properties: machine: - description: Machine contains MTU migration configuration + description: machine contains MTU migration configuration for the machine's uplink. properties: from: @@ -2754,7 +2754,7 @@ spec: type: integer type: object network: - description: Network contains MTU migration configuration + description: network contains MTU migration configuration for the default network. properties: from: @@ -2781,7 +2781,7 @@ spec: regeneration if this changes. type: string osImageURL: - description: OSImageURL is the old-format container image that contains + description: osImageURL is the old-format container image that contains the OS update payload. type: string platform: diff --git a/machineconfiguration/v1/zz_generated.crd-manifests/0000_80_machine-config_01_kubeletconfigs.crd.yaml b/machineconfiguration/v1/zz_generated.crd-manifests/0000_80_machine-config_01_kubeletconfigs.crd.yaml index 2da51f8c756..ef8e71377cb 100644 --- a/machineconfiguration/v1/zz_generated.crd-manifests/0000_80_machine-config_01_kubeletconfigs.crd.yaml +++ b/machineconfiguration/v1/zz_generated.crd-manifests/0000_80_machine-config_01_kubeletconfigs.crd.yaml @@ -61,7 +61,7 @@ spec: type: integer machineConfigPoolSelector: description: |- - MachineConfigPoolSelector selects which pools the KubeletConfig shoud apply to. + machineConfigPoolSelector selects which pools the KubeletConfig shoud apply to. A nil selector will result in no pools being selected. properties: matchExpressions: diff --git a/machineconfiguration/v1/zz_generated.crd-manifests/0000_80_machine-config_01_machineconfigs.crd.yaml b/machineconfiguration/v1/zz_generated.crd-manifests/0000_80_machine-config_01_machineconfigs.crd.yaml index f878dd7ed51..df90d44d023 100644 --- a/machineconfiguration/v1/zz_generated.crd-manifests/0000_80_machine-config_01_machineconfigs.crd.yaml +++ b/machineconfiguration/v1/zz_generated.crd-manifests/0000_80_machine-config_01_machineconfigs.crd.yaml @@ -63,11 +63,11 @@ spec: properties: baseOSExtensionsContainerImage: description: |- - BaseOSExtensionsContainerImage specifies the remote location that will be used + baseOSExtensionsContainerImage specifies the remote location that will be used to fetch the extensions container matching a new-format OS image type: string config: - description: Config is a Ignition Config object. + description: config is a Ignition Config object. type: object x-kubernetes-preserve-unknown-fields: true extensions: @@ -95,7 +95,7 @@ spec: type: string osImageURL: description: |- - OSImageURL specifies the remote location that will be used to + osImageURL specifies the remote location that will be used to fetch the OS. type: string type: object diff --git a/machineconfiguration/v1/zz_generated.featuregated-crd-manifests/containerruntimeconfigs.machineconfiguration.openshift.io/AAA_ungated.yaml b/machineconfiguration/v1/zz_generated.featuregated-crd-manifests/containerruntimeconfigs.machineconfiguration.openshift.io/AAA_ungated.yaml index d20bb133dc2..f4d687171ab 100644 --- a/machineconfiguration/v1/zz_generated.featuregated-crd-manifests/containerruntimeconfigs.machineconfiguration.openshift.io/AAA_ungated.yaml +++ b/machineconfiguration/v1/zz_generated.featuregated-crd-manifests/containerruntimeconfigs.machineconfiguration.openshift.io/AAA_ungated.yaml @@ -89,7 +89,7 @@ spec: type: object machineConfigPoolSelector: description: |- - MachineConfigPoolSelector selects which pools the ContainerRuntimeConfig shoud apply to. + machineConfigPoolSelector selects which pools the ContainerRuntimeConfig shoud apply to. A nil selector will result in no pools being selected. properties: matchExpressions: diff --git a/machineconfiguration/v1/zz_generated.featuregated-crd-manifests/controllerconfigs.machineconfiguration.openshift.io/AAA_ungated.yaml b/machineconfiguration/v1/zz_generated.featuregated-crd-manifests/controllerconfigs.machineconfiguration.openshift.io/AAA_ungated.yaml index c0352d8f02b..544d5d91ede 100644 --- a/machineconfiguration/v1/zz_generated.featuregated-crd-manifests/controllerconfigs.machineconfiguration.openshift.io/AAA_ungated.yaml +++ b/machineconfiguration/v1/zz_generated.featuregated-crd-manifests/controllerconfigs.machineconfiguration.openshift.io/AAA_ungated.yaml @@ -56,11 +56,11 @@ spec: nullable: true type: string baseOSContainerImage: - description: BaseOSContainerImage is the new-format container image + description: baseOSContainerImage is the new-format container image for operating system updates. type: string baseOSExtensionsContainerImage: - description: BaseOSExtensionsContainerImage is the matching extensions + description: baseOSExtensionsContainerImage is the matching extensions container for the new-format container type: string cloudProviderCAData: @@ -337,7 +337,7 @@ spec: All the clients are expected to use the generated ConfigMap only. properties: key: - description: Key allows pointing to a specific key/value + description: key allows pointing to a specific key/value inside of the configmap. This is useful for logical file references. type: string @@ -350,11 +350,11 @@ spec: infrastructure provider. properties: alibabaCloud: - description: AlibabaCloud contains settings specific to + description: alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. type: object aws: - description: AWS contains settings specific to the Amazon + description: aws contains settings specific to the Amazon Web Services infrastructure provider. properties: serviceEndpoints: @@ -386,11 +386,11 @@ spec: x-kubernetes-list-type: atomic type: object azure: - description: Azure contains settings specific to the Azure + description: azure contains settings specific to the Azure infrastructure provider. type: object baremetal: - description: BareMetal contains settings specific to the + description: baremetal contains settings specific to the BareMetal platform. properties: apiServerInternalIPs: @@ -477,7 +477,7 @@ spec: - message: ingressIPs list is required once set rule: '!has(oldSelf.ingressIPs) || has(self.ingressIPs)' equinixMetal: - description: EquinixMetal contains settings specific to + description: equinixMetal contains settings specific to the Equinix Metal infrastructure provider. type: object external: @@ -488,7 +488,7 @@ spec: platformName: default: Unknown description: |- - PlatformName holds the arbitrary string representing the infrastructure provider name, expected to be set at the installation time. + 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 x-kubernetes-validations: @@ -496,19 +496,19 @@ spec: rule: oldSelf == 'Unknown' || self == oldSelf type: object gcp: - description: GCP contains settings specific to the Google + description: gcp contains settings specific to the Google Cloud Platform infrastructure provider. type: object ibmcloud: - description: IBMCloud contains settings specific to the + description: ibmcloud contains settings specific to the IBMCloud infrastructure provider. type: object kubevirt: - description: Kubevirt contains settings specific to the + description: kubevirt contains settings specific to the kubevirt infrastructure provider. type: object nutanix: - description: Nutanix contains settings specific to the + description: nutanix contains settings specific to the Nutanix infrastructure provider. properties: failureDomains: @@ -698,7 +698,7 @@ spec: - prismElements type: object openstack: - description: OpenStack contains settings specific to the + description: openstack contains settings specific to the OpenStack infrastructure provider. properties: apiServerInternalIPs: @@ -785,11 +785,11 @@ spec: - message: ingressIPs list is required once set rule: '!has(oldSelf.ingressIPs) || has(self.ingressIPs)' ovirt: - description: Ovirt contains settings specific to the oVirt + description: ovirt contains settings specific to the oVirt infrastructure provider. type: object powervs: - description: PowerVS contains settings specific to the + description: powervs contains settings specific to the IBM Power Systems Virtual Servers infrastructure provider. properties: serviceEndpoints: @@ -871,7 +871,7 @@ spec: - External type: string vsphere: - description: VSphere contains settings specific to the + description: vsphere contains settings specific to the VSphere infrastructure provider. properties: apiServerInternalIPs: @@ -953,7 +953,7 @@ spec: minLength: 1 type: string topology: - description: Topology describes a given failure + description: topology describes a given failure domain using vSphere constructs properties: computeCluster: @@ -1390,7 +1390,7 @@ spec: infrastructure provider. properties: alibabaCloud: - description: AlibabaCloud contains settings specific to + description: alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. properties: region: @@ -1434,7 +1434,7 @@ spec: - region type: object aws: - description: AWS contains settings specific to the Amazon + description: aws contains settings specific to the Amazon Web Services infrastructure provider. properties: region: @@ -1475,7 +1475,7 @@ spec: x-kubernetes-list-type: atomic serviceEndpoints: description: |- - ServiceEndpoints list contains custom endpoints which will override default + serviceEndpoints list contains custom endpoints which will override default service endpoint of AWS Services. There must be only one ServiceEndpoint for a service. items: @@ -1502,7 +1502,7 @@ spec: x-kubernetes-list-type: atomic type: object azure: - description: Azure contains settings specific to the Azure + description: azure contains settings specific to the Azure infrastructure provider. properties: armEndpoint: @@ -1578,7 +1578,7 @@ spec: rule: '!has(oldSelf.resourceTags) && !has(self.resourceTags) || has(oldSelf.resourceTags) && has(self.resourceTags)' baremetal: - description: BareMetal contains settings specific to the + description: baremetal contains settings specific to the BareMetal platform. properties: apiServerInternalIP: @@ -1662,7 +1662,7 @@ spec: type: string type: object equinixMetal: - description: EquinixMetal contains settings specific to + description: equinixMetal contains settings specific to the Equinix Metal infrastructure provider. properties: apiServerInternalIP: @@ -1679,7 +1679,7 @@ spec: type: string type: object external: - description: External contains settings specific to the + description: external contains settings specific to the generic External infrastructure provider. properties: cloudControllerManager: @@ -1719,7 +1719,7 @@ spec: removed once set rule: has(self.cloudControllerManager) == has(oldSelf.cloudControllerManager) gcp: - description: GCP contains settings specific to the Google + description: gcp contains settings specific to the Google Cloud Platform infrastructure provider. properties: projectID: @@ -1732,29 +1732,29 @@ spec: type: string type: object ibmcloud: - description: IBMCloud contains settings specific to the + description: ibmcloud contains settings specific to the IBMCloud infrastructure provider. properties: cisInstanceCRN: description: |- - CISInstanceCRN is the CRN of the Cloud Internet Services instance managing + 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 + 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 + description: location is where the cluster has been deployed type: string providerType: - description: ProviderType indicates the type of cluster + description: providerType indicates the type of cluster that was created type: string resourceGroupName: - description: ResourceGroupName is the Resource Group + description: resourceGroupName is the Resource Group for new IBMCloud resources created for the cluster. type: string serviceEndpoints: @@ -1809,7 +1809,7 @@ spec: x-kubernetes-list-type: map type: object kubevirt: - description: Kubevirt contains settings specific to the + description: kubevirt contains settings specific to the kubevirt infrastructure provider. properties: apiServerInternalIP: @@ -1826,7 +1826,7 @@ spec: type: string type: object nutanix: - description: Nutanix contains settings specific to the + description: nutanix contains settings specific to the Nutanix infrastructure provider. properties: apiServerInternalIP: @@ -1884,7 +1884,7 @@ spec: : true)' type: object openstack: - description: OpenStack contains settings specific to the + description: openstack contains settings specific to the OpenStack infrastructure provider. properties: apiServerInternalIP: @@ -1999,7 +1999,7 @@ spec: type: string type: object ovirt: - description: Ovirt contains settings specific to the oVirt + description: ovirt contains settings specific to the oVirt infrastructure provider. properties: apiServerInternalIP: @@ -2062,17 +2062,17 @@ spec: type: string type: object powervs: - description: PowerVS contains settings specific to the + description: powervs contains settings specific to the Power Systems Virtual Servers infrastructure provider. properties: cisInstanceCRN: description: |- - CISInstanceCRN is the CRN of the Cloud Internet Services instance managing + 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 + dnsInstanceCRN is the CRN of the DNS Services instance managing the DNS zone for the cluster's base domain type: string region: @@ -2182,7 +2182,7 @@ spec: - External type: string vsphere: - description: VSphere contains settings specific to the + description: vsphere contains settings specific to the VSphere infrastructure provider. properties: apiServerInternalIP: @@ -2288,15 +2288,15 @@ spec: format: byte type: string network: - description: Network contains additional network related information + description: network contains additional network related information nullable: true properties: mtuMigration: - description: MTUMigration contains the MTU migration configuration. + description: mtuMigration contains the MTU migration configuration. nullable: true properties: machine: - description: Machine contains MTU migration configuration + description: machine contains MTU migration configuration for the machine's uplink. properties: from: @@ -2311,7 +2311,7 @@ spec: type: integer type: object network: - description: Network contains MTU migration configuration + description: network contains MTU migration configuration for the default network. properties: from: @@ -2338,7 +2338,7 @@ spec: regeneration if this changes. type: string osImageURL: - description: OSImageURL is the old-format container image that contains + description: osImageURL is the old-format container image that contains the OS update payload. type: string platform: diff --git a/machineconfiguration/v1/zz_generated.featuregated-crd-manifests/controllerconfigs.machineconfiguration.openshift.io/AWSClusterHostedDNS.yaml b/machineconfiguration/v1/zz_generated.featuregated-crd-manifests/controllerconfigs.machineconfiguration.openshift.io/AWSClusterHostedDNS.yaml index a30caf16049..26bbf4d3be1 100644 --- a/machineconfiguration/v1/zz_generated.featuregated-crd-manifests/controllerconfigs.machineconfiguration.openshift.io/AWSClusterHostedDNS.yaml +++ b/machineconfiguration/v1/zz_generated.featuregated-crd-manifests/controllerconfigs.machineconfiguration.openshift.io/AWSClusterHostedDNS.yaml @@ -56,11 +56,11 @@ spec: nullable: true type: string baseOSContainerImage: - description: BaseOSContainerImage is the new-format container image + description: baseOSContainerImage is the new-format container image for operating system updates. type: string baseOSExtensionsContainerImage: - description: BaseOSExtensionsContainerImage is the matching extensions + description: baseOSExtensionsContainerImage is the matching extensions container for the new-format container type: string cloudProviderCAData: @@ -337,7 +337,7 @@ spec: All the clients are expected to use the generated ConfigMap only. properties: key: - description: Key allows pointing to a specific key/value + description: key allows pointing to a specific key/value inside of the configmap. This is useful for logical file references. type: string @@ -350,11 +350,11 @@ spec: infrastructure provider. properties: alibabaCloud: - description: AlibabaCloud contains settings specific to + description: alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. type: object aws: - description: AWS contains settings specific to the Amazon + description: aws contains settings specific to the Amazon Web Services infrastructure provider. properties: serviceEndpoints: @@ -386,11 +386,11 @@ spec: x-kubernetes-list-type: atomic type: object azure: - description: Azure contains settings specific to the Azure + description: azure contains settings specific to the Azure infrastructure provider. type: object baremetal: - description: BareMetal contains settings specific to the + description: baremetal contains settings specific to the BareMetal platform. properties: apiServerInternalIPs: @@ -477,7 +477,7 @@ spec: - message: ingressIPs list is required once set rule: '!has(oldSelf.ingressIPs) || has(self.ingressIPs)' equinixMetal: - description: EquinixMetal contains settings specific to + description: equinixMetal contains settings specific to the Equinix Metal infrastructure provider. type: object external: @@ -488,7 +488,7 @@ spec: platformName: default: Unknown description: |- - PlatformName holds the arbitrary string representing the infrastructure provider name, expected to be set at the installation time. + 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 x-kubernetes-validations: @@ -496,19 +496,19 @@ spec: rule: oldSelf == 'Unknown' || self == oldSelf type: object gcp: - description: GCP contains settings specific to the Google + description: gcp contains settings specific to the Google Cloud Platform infrastructure provider. type: object ibmcloud: - description: IBMCloud contains settings specific to the + description: ibmcloud contains settings specific to the IBMCloud infrastructure provider. type: object kubevirt: - description: Kubevirt contains settings specific to the + description: kubevirt contains settings specific to the kubevirt infrastructure provider. type: object nutanix: - description: Nutanix contains settings specific to the + description: nutanix contains settings specific to the Nutanix infrastructure provider. properties: failureDomains: @@ -697,7 +697,7 @@ spec: - prismElements type: object openstack: - description: OpenStack contains settings specific to the + description: openstack contains settings specific to the OpenStack infrastructure provider. properties: apiServerInternalIPs: @@ -784,11 +784,11 @@ spec: - message: ingressIPs list is required once set rule: '!has(oldSelf.ingressIPs) || has(self.ingressIPs)' ovirt: - description: Ovirt contains settings specific to the oVirt + description: ovirt contains settings specific to the oVirt infrastructure provider. type: object powervs: - description: PowerVS contains settings specific to the + description: powervs contains settings specific to the IBM Power Systems Virtual Servers infrastructure provider. properties: serviceEndpoints: @@ -870,7 +870,7 @@ spec: - External type: string vsphere: - description: VSphere contains settings specific to the + description: vsphere contains settings specific to the VSphere infrastructure provider. properties: apiServerInternalIPs: @@ -952,7 +952,7 @@ spec: minLength: 1 type: string topology: - description: Topology describes a given failure + description: topology describes a given failure domain using vSphere constructs properties: computeCluster: @@ -1387,7 +1387,7 @@ spec: infrastructure provider. properties: alibabaCloud: - description: AlibabaCloud contains settings specific to + description: alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. properties: region: @@ -1431,7 +1431,7 @@ spec: - region type: object aws: - description: AWS contains settings specific to the Amazon + description: aws contains settings specific to the Amazon Web Services infrastructure provider. properties: cloudLoadBalancerConfig: @@ -1576,7 +1576,7 @@ spec: x-kubernetes-list-type: atomic serviceEndpoints: description: |- - ServiceEndpoints list contains custom endpoints which will override default + serviceEndpoints list contains custom endpoints which will override default service endpoint of AWS Services. There must be only one ServiceEndpoint for a service. items: @@ -1603,7 +1603,7 @@ spec: x-kubernetes-list-type: atomic type: object azure: - description: Azure contains settings specific to the Azure + description: azure contains settings specific to the Azure infrastructure provider. properties: armEndpoint: @@ -1679,7 +1679,7 @@ spec: rule: '!has(oldSelf.resourceTags) && !has(self.resourceTags) || has(oldSelf.resourceTags) && has(self.resourceTags)' baremetal: - description: BareMetal contains settings specific to the + description: baremetal contains settings specific to the BareMetal platform. properties: apiServerInternalIP: @@ -1763,7 +1763,7 @@ spec: type: string type: object equinixMetal: - description: EquinixMetal contains settings specific to + description: equinixMetal contains settings specific to the Equinix Metal infrastructure provider. properties: apiServerInternalIP: @@ -1780,7 +1780,7 @@ spec: type: string type: object external: - description: External contains settings specific to the + description: external contains settings specific to the generic External infrastructure provider. properties: cloudControllerManager: @@ -1820,7 +1820,7 @@ spec: removed once set rule: has(self.cloudControllerManager) == has(oldSelf.cloudControllerManager) gcp: - description: GCP contains settings specific to the Google + description: gcp contains settings specific to the Google Cloud Platform infrastructure provider. properties: projectID: @@ -1833,29 +1833,29 @@ spec: type: string type: object ibmcloud: - description: IBMCloud contains settings specific to the + description: ibmcloud contains settings specific to the IBMCloud infrastructure provider. properties: cisInstanceCRN: description: |- - CISInstanceCRN is the CRN of the Cloud Internet Services instance managing + 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 + 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 + description: location is where the cluster has been deployed type: string providerType: - description: ProviderType indicates the type of cluster + description: providerType indicates the type of cluster that was created type: string resourceGroupName: - description: ResourceGroupName is the Resource Group + description: resourceGroupName is the Resource Group for new IBMCloud resources created for the cluster. type: string serviceEndpoints: @@ -1910,7 +1910,7 @@ spec: x-kubernetes-list-type: map type: object kubevirt: - description: Kubevirt contains settings specific to the + description: kubevirt contains settings specific to the kubevirt infrastructure provider. properties: apiServerInternalIP: @@ -1927,7 +1927,7 @@ spec: type: string type: object nutanix: - description: Nutanix contains settings specific to the + description: nutanix contains settings specific to the Nutanix infrastructure provider. properties: apiServerInternalIP: @@ -1985,7 +1985,7 @@ spec: : true)' type: object openstack: - description: OpenStack contains settings specific to the + description: openstack contains settings specific to the OpenStack infrastructure provider. properties: apiServerInternalIP: @@ -2100,7 +2100,7 @@ spec: type: string type: object ovirt: - description: Ovirt contains settings specific to the oVirt + description: ovirt contains settings specific to the oVirt infrastructure provider. properties: apiServerInternalIP: @@ -2163,17 +2163,17 @@ spec: type: string type: object powervs: - description: PowerVS contains settings specific to the + description: powervs contains settings specific to the Power Systems Virtual Servers infrastructure provider. properties: cisInstanceCRN: description: |- - CISInstanceCRN is the CRN of the Cloud Internet Services instance managing + 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 + dnsInstanceCRN is the CRN of the DNS Services instance managing the DNS zone for the cluster's base domain type: string region: @@ -2283,7 +2283,7 @@ spec: - External type: string vsphere: - description: VSphere contains settings specific to the + description: vsphere contains settings specific to the VSphere infrastructure provider. properties: apiServerInternalIP: @@ -2389,15 +2389,15 @@ spec: format: byte type: string network: - description: Network contains additional network related information + description: network contains additional network related information nullable: true properties: mtuMigration: - description: MTUMigration contains the MTU migration configuration. + description: mtuMigration contains the MTU migration configuration. nullable: true properties: machine: - description: Machine contains MTU migration configuration + description: machine contains MTU migration configuration for the machine's uplink. properties: from: @@ -2412,7 +2412,7 @@ spec: type: integer type: object network: - description: Network contains MTU migration configuration + description: network contains MTU migration configuration for the default network. properties: from: @@ -2439,7 +2439,7 @@ spec: regeneration if this changes. type: string osImageURL: - description: OSImageURL is the old-format container image that contains + description: osImageURL is the old-format container image that contains the OS update payload. type: string platform: diff --git a/machineconfiguration/v1/zz_generated.featuregated-crd-manifests/controllerconfigs.machineconfiguration.openshift.io/BareMetalLoadBalancer.yaml b/machineconfiguration/v1/zz_generated.featuregated-crd-manifests/controllerconfigs.machineconfiguration.openshift.io/BareMetalLoadBalancer.yaml index 29ab4878e46..6d40a976a0c 100644 --- a/machineconfiguration/v1/zz_generated.featuregated-crd-manifests/controllerconfigs.machineconfiguration.openshift.io/BareMetalLoadBalancer.yaml +++ b/machineconfiguration/v1/zz_generated.featuregated-crd-manifests/controllerconfigs.machineconfiguration.openshift.io/BareMetalLoadBalancer.yaml @@ -56,11 +56,11 @@ spec: nullable: true type: string baseOSContainerImage: - description: BaseOSContainerImage is the new-format container image + description: baseOSContainerImage is the new-format container image for operating system updates. type: string baseOSExtensionsContainerImage: - description: BaseOSExtensionsContainerImage is the matching extensions + description: baseOSExtensionsContainerImage is the matching extensions container for the new-format container type: string cloudProviderCAData: @@ -337,7 +337,7 @@ spec: All the clients are expected to use the generated ConfigMap only. properties: key: - description: Key allows pointing to a specific key/value + description: key allows pointing to a specific key/value inside of the configmap. This is useful for logical file references. type: string @@ -350,11 +350,11 @@ spec: infrastructure provider. properties: alibabaCloud: - description: AlibabaCloud contains settings specific to + description: alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. type: object aws: - description: AWS contains settings specific to the Amazon + description: aws contains settings specific to the Amazon Web Services infrastructure provider. properties: serviceEndpoints: @@ -386,11 +386,11 @@ spec: x-kubernetes-list-type: atomic type: object azure: - description: Azure contains settings specific to the Azure + description: azure contains settings specific to the Azure infrastructure provider. type: object baremetal: - description: BareMetal contains settings specific to the + description: baremetal contains settings specific to the BareMetal platform. properties: apiServerInternalIPs: @@ -477,7 +477,7 @@ spec: - message: ingressIPs list is required once set rule: '!has(oldSelf.ingressIPs) || has(self.ingressIPs)' equinixMetal: - description: EquinixMetal contains settings specific to + description: equinixMetal contains settings specific to the Equinix Metal infrastructure provider. type: object external: @@ -488,7 +488,7 @@ spec: platformName: default: Unknown description: |- - PlatformName holds the arbitrary string representing the infrastructure provider name, expected to be set at the installation time. + 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 x-kubernetes-validations: @@ -496,19 +496,19 @@ spec: rule: oldSelf == 'Unknown' || self == oldSelf type: object gcp: - description: GCP contains settings specific to the Google + description: gcp contains settings specific to the Google Cloud Platform infrastructure provider. type: object ibmcloud: - description: IBMCloud contains settings specific to the + description: ibmcloud contains settings specific to the IBMCloud infrastructure provider. type: object kubevirt: - description: Kubevirt contains settings specific to the + description: kubevirt contains settings specific to the kubevirt infrastructure provider. type: object nutanix: - description: Nutanix contains settings specific to the + description: nutanix contains settings specific to the Nutanix infrastructure provider. properties: failureDomains: @@ -697,7 +697,7 @@ spec: - prismElements type: object openstack: - description: OpenStack contains settings specific to the + description: openstack contains settings specific to the OpenStack infrastructure provider. properties: apiServerInternalIPs: @@ -784,11 +784,11 @@ spec: - message: ingressIPs list is required once set rule: '!has(oldSelf.ingressIPs) || has(self.ingressIPs)' ovirt: - description: Ovirt contains settings specific to the oVirt + description: ovirt contains settings specific to the oVirt infrastructure provider. type: object powervs: - description: PowerVS contains settings specific to the + description: powervs contains settings specific to the IBM Power Systems Virtual Servers infrastructure provider. properties: serviceEndpoints: @@ -870,7 +870,7 @@ spec: - External type: string vsphere: - description: VSphere contains settings specific to the + description: vsphere contains settings specific to the VSphere infrastructure provider. properties: apiServerInternalIPs: @@ -952,7 +952,7 @@ spec: minLength: 1 type: string topology: - description: Topology describes a given failure + description: topology describes a given failure domain using vSphere constructs properties: computeCluster: @@ -1387,7 +1387,7 @@ spec: infrastructure provider. properties: alibabaCloud: - description: AlibabaCloud contains settings specific to + description: alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. properties: region: @@ -1431,7 +1431,7 @@ spec: - region type: object aws: - description: AWS contains settings specific to the Amazon + description: aws contains settings specific to the Amazon Web Services infrastructure provider. properties: region: @@ -1472,7 +1472,7 @@ spec: x-kubernetes-list-type: atomic serviceEndpoints: description: |- - ServiceEndpoints list contains custom endpoints which will override default + serviceEndpoints list contains custom endpoints which will override default service endpoint of AWS Services. There must be only one ServiceEndpoint for a service. items: @@ -1499,7 +1499,7 @@ spec: x-kubernetes-list-type: atomic type: object azure: - description: Azure contains settings specific to the Azure + description: azure contains settings specific to the Azure infrastructure provider. properties: armEndpoint: @@ -1575,7 +1575,7 @@ spec: rule: '!has(oldSelf.resourceTags) && !has(self.resourceTags) || has(oldSelf.resourceTags) && has(self.resourceTags)' baremetal: - description: BareMetal contains settings specific to the + description: baremetal contains settings specific to the BareMetal platform. properties: apiServerInternalIP: @@ -1685,7 +1685,7 @@ spec: type: string type: object equinixMetal: - description: EquinixMetal contains settings specific to + description: equinixMetal contains settings specific to the Equinix Metal infrastructure provider. properties: apiServerInternalIP: @@ -1702,7 +1702,7 @@ spec: type: string type: object external: - description: External contains settings specific to the + description: external contains settings specific to the generic External infrastructure provider. properties: cloudControllerManager: @@ -1742,7 +1742,7 @@ spec: removed once set rule: has(self.cloudControllerManager) == has(oldSelf.cloudControllerManager) gcp: - description: GCP contains settings specific to the Google + description: gcp contains settings specific to the Google Cloud Platform infrastructure provider. properties: projectID: @@ -1755,29 +1755,29 @@ spec: type: string type: object ibmcloud: - description: IBMCloud contains settings specific to the + description: ibmcloud contains settings specific to the IBMCloud infrastructure provider. properties: cisInstanceCRN: description: |- - CISInstanceCRN is the CRN of the Cloud Internet Services instance managing + 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 + 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 + description: location is where the cluster has been deployed type: string providerType: - description: ProviderType indicates the type of cluster + description: providerType indicates the type of cluster that was created type: string resourceGroupName: - description: ResourceGroupName is the Resource Group + description: resourceGroupName is the Resource Group for new IBMCloud resources created for the cluster. type: string serviceEndpoints: @@ -1832,7 +1832,7 @@ spec: x-kubernetes-list-type: map type: object kubevirt: - description: Kubevirt contains settings specific to the + description: kubevirt contains settings specific to the kubevirt infrastructure provider. properties: apiServerInternalIP: @@ -1849,7 +1849,7 @@ spec: type: string type: object nutanix: - description: Nutanix contains settings specific to the + description: nutanix contains settings specific to the Nutanix infrastructure provider. properties: apiServerInternalIP: @@ -1933,7 +1933,7 @@ spec: type: object type: object openstack: - description: OpenStack contains settings specific to the + description: openstack contains settings specific to the OpenStack infrastructure provider. properties: apiServerInternalIP: @@ -2048,7 +2048,7 @@ spec: type: string type: object ovirt: - description: Ovirt contains settings specific to the oVirt + description: ovirt contains settings specific to the oVirt infrastructure provider. properties: apiServerInternalIP: @@ -2137,17 +2137,17 @@ spec: type: string type: object powervs: - description: PowerVS contains settings specific to the + description: powervs contains settings specific to the Power Systems Virtual Servers infrastructure provider. properties: cisInstanceCRN: description: |- - CISInstanceCRN is the CRN of the Cloud Internet Services instance managing + 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 + dnsInstanceCRN is the CRN of the DNS Services instance managing the DNS zone for the cluster's base domain type: string region: @@ -2257,7 +2257,7 @@ spec: - External type: string vsphere: - description: VSphere contains settings specific to the + description: vsphere contains settings specific to the VSphere infrastructure provider. properties: apiServerInternalIP: @@ -2389,15 +2389,15 @@ spec: format: byte type: string network: - description: Network contains additional network related information + description: network contains additional network related information nullable: true properties: mtuMigration: - description: MTUMigration contains the MTU migration configuration. + description: mtuMigration contains the MTU migration configuration. nullable: true properties: machine: - description: Machine contains MTU migration configuration + description: machine contains MTU migration configuration for the machine's uplink. properties: from: @@ -2412,7 +2412,7 @@ spec: type: integer type: object network: - description: Network contains MTU migration configuration + description: network contains MTU migration configuration for the default network. properties: from: @@ -2439,7 +2439,7 @@ spec: regeneration if this changes. type: string osImageURL: - description: OSImageURL is the old-format container image that contains + description: osImageURL is the old-format container image that contains the OS update payload. type: string platform: diff --git a/machineconfiguration/v1/zz_generated.featuregated-crd-manifests/controllerconfigs.machineconfiguration.openshift.io/GCPClusterHostedDNS.yaml b/machineconfiguration/v1/zz_generated.featuregated-crd-manifests/controllerconfigs.machineconfiguration.openshift.io/GCPClusterHostedDNS.yaml index 31473bfea28..6ef0b1c0da6 100644 --- a/machineconfiguration/v1/zz_generated.featuregated-crd-manifests/controllerconfigs.machineconfiguration.openshift.io/GCPClusterHostedDNS.yaml +++ b/machineconfiguration/v1/zz_generated.featuregated-crd-manifests/controllerconfigs.machineconfiguration.openshift.io/GCPClusterHostedDNS.yaml @@ -56,11 +56,11 @@ spec: nullable: true type: string baseOSContainerImage: - description: BaseOSContainerImage is the new-format container image + description: baseOSContainerImage is the new-format container image for operating system updates. type: string baseOSExtensionsContainerImage: - description: BaseOSExtensionsContainerImage is the matching extensions + description: baseOSExtensionsContainerImage is the matching extensions container for the new-format container type: string cloudProviderCAData: @@ -337,7 +337,7 @@ spec: All the clients are expected to use the generated ConfigMap only. properties: key: - description: Key allows pointing to a specific key/value + description: key allows pointing to a specific key/value inside of the configmap. This is useful for logical file references. type: string @@ -350,11 +350,11 @@ spec: infrastructure provider. properties: alibabaCloud: - description: AlibabaCloud contains settings specific to + description: alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. type: object aws: - description: AWS contains settings specific to the Amazon + description: aws contains settings specific to the Amazon Web Services infrastructure provider. properties: serviceEndpoints: @@ -386,11 +386,11 @@ spec: x-kubernetes-list-type: atomic type: object azure: - description: Azure contains settings specific to the Azure + description: azure contains settings specific to the Azure infrastructure provider. type: object baremetal: - description: BareMetal contains settings specific to the + description: baremetal contains settings specific to the BareMetal platform. properties: apiServerInternalIPs: @@ -477,7 +477,7 @@ spec: - message: ingressIPs list is required once set rule: '!has(oldSelf.ingressIPs) || has(self.ingressIPs)' equinixMetal: - description: EquinixMetal contains settings specific to + description: equinixMetal contains settings specific to the Equinix Metal infrastructure provider. type: object external: @@ -488,7 +488,7 @@ spec: platformName: default: Unknown description: |- - PlatformName holds the arbitrary string representing the infrastructure provider name, expected to be set at the installation time. + 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 x-kubernetes-validations: @@ -496,19 +496,19 @@ spec: rule: oldSelf == 'Unknown' || self == oldSelf type: object gcp: - description: GCP contains settings specific to the Google + description: gcp contains settings specific to the Google Cloud Platform infrastructure provider. type: object ibmcloud: - description: IBMCloud contains settings specific to the + description: ibmcloud contains settings specific to the IBMCloud infrastructure provider. type: object kubevirt: - description: Kubevirt contains settings specific to the + description: kubevirt contains settings specific to the kubevirt infrastructure provider. type: object nutanix: - description: Nutanix contains settings specific to the + description: nutanix contains settings specific to the Nutanix infrastructure provider. properties: failureDomains: @@ -697,7 +697,7 @@ spec: - prismElements type: object openstack: - description: OpenStack contains settings specific to the + description: openstack contains settings specific to the OpenStack infrastructure provider. properties: apiServerInternalIPs: @@ -784,11 +784,11 @@ spec: - message: ingressIPs list is required once set rule: '!has(oldSelf.ingressIPs) || has(self.ingressIPs)' ovirt: - description: Ovirt contains settings specific to the oVirt + description: ovirt contains settings specific to the oVirt infrastructure provider. type: object powervs: - description: PowerVS contains settings specific to the + description: powervs contains settings specific to the IBM Power Systems Virtual Servers infrastructure provider. properties: serviceEndpoints: @@ -870,7 +870,7 @@ spec: - External type: string vsphere: - description: VSphere contains settings specific to the + description: vsphere contains settings specific to the VSphere infrastructure provider. properties: apiServerInternalIPs: @@ -952,7 +952,7 @@ spec: minLength: 1 type: string topology: - description: Topology describes a given failure + description: topology describes a given failure domain using vSphere constructs properties: computeCluster: @@ -1387,7 +1387,7 @@ spec: infrastructure provider. properties: alibabaCloud: - description: AlibabaCloud contains settings specific to + description: alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. properties: region: @@ -1431,7 +1431,7 @@ spec: - region type: object aws: - description: AWS contains settings specific to the Amazon + description: aws contains settings specific to the Amazon Web Services infrastructure provider. properties: region: @@ -1472,7 +1472,7 @@ spec: x-kubernetes-list-type: atomic serviceEndpoints: description: |- - ServiceEndpoints list contains custom endpoints which will override default + serviceEndpoints list contains custom endpoints which will override default service endpoint of AWS Services. There must be only one ServiceEndpoint for a service. items: @@ -1499,7 +1499,7 @@ spec: x-kubernetes-list-type: atomic type: object azure: - description: Azure contains settings specific to the Azure + description: azure contains settings specific to the Azure infrastructure provider. properties: armEndpoint: @@ -1575,7 +1575,7 @@ spec: rule: '!has(oldSelf.resourceTags) && !has(self.resourceTags) || has(oldSelf.resourceTags) && has(self.resourceTags)' baremetal: - description: BareMetal contains settings specific to the + description: baremetal contains settings specific to the BareMetal platform. properties: apiServerInternalIP: @@ -1659,7 +1659,7 @@ spec: type: string type: object equinixMetal: - description: EquinixMetal contains settings specific to + description: equinixMetal contains settings specific to the Equinix Metal infrastructure provider. properties: apiServerInternalIP: @@ -1676,7 +1676,7 @@ spec: type: string type: object external: - description: External contains settings specific to the + description: external contains settings specific to the generic External infrastructure provider. properties: cloudControllerManager: @@ -1716,7 +1716,7 @@ spec: removed once set rule: has(self.cloudControllerManager) == has(oldSelf.cloudControllerManager) gcp: - description: GCP contains settings specific to the Google + description: gcp contains settings specific to the Google Cloud Platform infrastructure provider. properties: cloudLoadBalancerConfig: @@ -1833,29 +1833,29 @@ spec: type: string type: object ibmcloud: - description: IBMCloud contains settings specific to the + description: ibmcloud contains settings specific to the IBMCloud infrastructure provider. properties: cisInstanceCRN: description: |- - CISInstanceCRN is the CRN of the Cloud Internet Services instance managing + 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 + 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 + description: location is where the cluster has been deployed type: string providerType: - description: ProviderType indicates the type of cluster + description: providerType indicates the type of cluster that was created type: string resourceGroupName: - description: ResourceGroupName is the Resource Group + description: resourceGroupName is the Resource Group for new IBMCloud resources created for the cluster. type: string serviceEndpoints: @@ -1910,7 +1910,7 @@ spec: x-kubernetes-list-type: map type: object kubevirt: - description: Kubevirt contains settings specific to the + description: kubevirt contains settings specific to the kubevirt infrastructure provider. properties: apiServerInternalIP: @@ -1927,7 +1927,7 @@ spec: type: string type: object nutanix: - description: Nutanix contains settings specific to the + description: nutanix contains settings specific to the Nutanix infrastructure provider. properties: apiServerInternalIP: @@ -1985,7 +1985,7 @@ spec: : true)' type: object openstack: - description: OpenStack contains settings specific to the + description: openstack contains settings specific to the OpenStack infrastructure provider. properties: apiServerInternalIP: @@ -2100,7 +2100,7 @@ spec: type: string type: object ovirt: - description: Ovirt contains settings specific to the oVirt + description: ovirt contains settings specific to the oVirt infrastructure provider. properties: apiServerInternalIP: @@ -2163,17 +2163,17 @@ spec: type: string type: object powervs: - description: PowerVS contains settings specific to the + description: powervs contains settings specific to the Power Systems Virtual Servers infrastructure provider. properties: cisInstanceCRN: description: |- - CISInstanceCRN is the CRN of the Cloud Internet Services instance managing + 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 + dnsInstanceCRN is the CRN of the DNS Services instance managing the DNS zone for the cluster's base domain type: string region: @@ -2283,7 +2283,7 @@ spec: - External type: string vsphere: - description: VSphere contains settings specific to the + description: vsphere contains settings specific to the VSphere infrastructure provider. properties: apiServerInternalIP: @@ -2389,15 +2389,15 @@ spec: format: byte type: string network: - description: Network contains additional network related information + description: network contains additional network related information nullable: true properties: mtuMigration: - description: MTUMigration contains the MTU migration configuration. + description: mtuMigration contains the MTU migration configuration. nullable: true properties: machine: - description: Machine contains MTU migration configuration + description: machine contains MTU migration configuration for the machine's uplink. properties: from: @@ -2412,7 +2412,7 @@ spec: type: integer type: object network: - description: Network contains MTU migration configuration + description: network contains MTU migration configuration for the default network. properties: from: @@ -2439,7 +2439,7 @@ spec: regeneration if this changes. type: string osImageURL: - description: OSImageURL is the old-format container image that contains + description: osImageURL is the old-format container image that contains the OS update payload. type: string platform: diff --git a/machineconfiguration/v1/zz_generated.featuregated-crd-manifests/controllerconfigs.machineconfiguration.openshift.io/GCPLabelsTags.yaml b/machineconfiguration/v1/zz_generated.featuregated-crd-manifests/controllerconfigs.machineconfiguration.openshift.io/GCPLabelsTags.yaml index 3d3918fbaf6..4e5b42ec6b2 100644 --- a/machineconfiguration/v1/zz_generated.featuregated-crd-manifests/controllerconfigs.machineconfiguration.openshift.io/GCPLabelsTags.yaml +++ b/machineconfiguration/v1/zz_generated.featuregated-crd-manifests/controllerconfigs.machineconfiguration.openshift.io/GCPLabelsTags.yaml @@ -56,11 +56,11 @@ spec: nullable: true type: string baseOSContainerImage: - description: BaseOSContainerImage is the new-format container image + description: baseOSContainerImage is the new-format container image for operating system updates. type: string baseOSExtensionsContainerImage: - description: BaseOSExtensionsContainerImage is the matching extensions + description: baseOSExtensionsContainerImage is the matching extensions container for the new-format container type: string cloudProviderCAData: @@ -337,7 +337,7 @@ spec: All the clients are expected to use the generated ConfigMap only. properties: key: - description: Key allows pointing to a specific key/value + description: key allows pointing to a specific key/value inside of the configmap. This is useful for logical file references. type: string @@ -350,11 +350,11 @@ spec: infrastructure provider. properties: alibabaCloud: - description: AlibabaCloud contains settings specific to + description: alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. type: object aws: - description: AWS contains settings specific to the Amazon + description: aws contains settings specific to the Amazon Web Services infrastructure provider. properties: serviceEndpoints: @@ -386,11 +386,11 @@ spec: x-kubernetes-list-type: atomic type: object azure: - description: Azure contains settings specific to the Azure + description: azure contains settings specific to the Azure infrastructure provider. type: object baremetal: - description: BareMetal contains settings specific to the + description: baremetal contains settings specific to the BareMetal platform. properties: apiServerInternalIPs: @@ -477,7 +477,7 @@ spec: - message: ingressIPs list is required once set rule: '!has(oldSelf.ingressIPs) || has(self.ingressIPs)' equinixMetal: - description: EquinixMetal contains settings specific to + description: equinixMetal contains settings specific to the Equinix Metal infrastructure provider. type: object external: @@ -488,7 +488,7 @@ spec: platformName: default: Unknown description: |- - PlatformName holds the arbitrary string representing the infrastructure provider name, expected to be set at the installation time. + 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 x-kubernetes-validations: @@ -496,19 +496,19 @@ spec: rule: oldSelf == 'Unknown' || self == oldSelf type: object gcp: - description: GCP contains settings specific to the Google + description: gcp contains settings specific to the Google Cloud Platform infrastructure provider. type: object ibmcloud: - description: IBMCloud contains settings specific to the + description: ibmcloud contains settings specific to the IBMCloud infrastructure provider. type: object kubevirt: - description: Kubevirt contains settings specific to the + description: kubevirt contains settings specific to the kubevirt infrastructure provider. type: object nutanix: - description: Nutanix contains settings specific to the + description: nutanix contains settings specific to the Nutanix infrastructure provider. properties: failureDomains: @@ -697,7 +697,7 @@ spec: - prismElements type: object openstack: - description: OpenStack contains settings specific to the + description: openstack contains settings specific to the OpenStack infrastructure provider. properties: apiServerInternalIPs: @@ -784,11 +784,11 @@ spec: - message: ingressIPs list is required once set rule: '!has(oldSelf.ingressIPs) || has(self.ingressIPs)' ovirt: - description: Ovirt contains settings specific to the oVirt + description: ovirt contains settings specific to the oVirt infrastructure provider. type: object powervs: - description: PowerVS contains settings specific to the + description: powervs contains settings specific to the IBM Power Systems Virtual Servers infrastructure provider. properties: serviceEndpoints: @@ -870,7 +870,7 @@ spec: - External type: string vsphere: - description: VSphere contains settings specific to the + description: vsphere contains settings specific to the VSphere infrastructure provider. properties: apiServerInternalIPs: @@ -952,7 +952,7 @@ spec: minLength: 1 type: string topology: - description: Topology describes a given failure + description: topology describes a given failure domain using vSphere constructs properties: computeCluster: @@ -1387,7 +1387,7 @@ spec: infrastructure provider. properties: alibabaCloud: - description: AlibabaCloud contains settings specific to + description: alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. properties: region: @@ -1431,7 +1431,7 @@ spec: - region type: object aws: - description: AWS contains settings specific to the Amazon + description: aws contains settings specific to the Amazon Web Services infrastructure provider. properties: region: @@ -1472,7 +1472,7 @@ spec: x-kubernetes-list-type: atomic serviceEndpoints: description: |- - ServiceEndpoints list contains custom endpoints which will override default + serviceEndpoints list contains custom endpoints which will override default service endpoint of AWS Services. There must be only one ServiceEndpoint for a service. items: @@ -1499,7 +1499,7 @@ spec: x-kubernetes-list-type: atomic type: object azure: - description: Azure contains settings specific to the Azure + description: azure contains settings specific to the Azure infrastructure provider. properties: armEndpoint: @@ -1575,7 +1575,7 @@ spec: rule: '!has(oldSelf.resourceTags) && !has(self.resourceTags) || has(oldSelf.resourceTags) && has(self.resourceTags)' baremetal: - description: BareMetal contains settings specific to the + description: baremetal contains settings specific to the BareMetal platform. properties: apiServerInternalIP: @@ -1659,7 +1659,7 @@ spec: type: string type: object equinixMetal: - description: EquinixMetal contains settings specific to + description: equinixMetal contains settings specific to the Equinix Metal infrastructure provider. properties: apiServerInternalIP: @@ -1676,7 +1676,7 @@ spec: type: string type: object external: - description: External contains settings specific to the + description: external contains settings specific to the generic External infrastructure provider. properties: cloudControllerManager: @@ -1716,7 +1716,7 @@ spec: removed once set rule: has(self.cloudControllerManager) == has(oldSelf.cloudControllerManager) gcp: - description: GCP contains settings specific to the Google + description: gcp contains settings specific to the Google Cloud Platform infrastructure provider. properties: projectID: @@ -1840,29 +1840,29 @@ spec: rule: '!has(oldSelf.resourceTags) && !has(self.resourceTags) || has(oldSelf.resourceTags) && has(self.resourceTags)' ibmcloud: - description: IBMCloud contains settings specific to the + description: ibmcloud contains settings specific to the IBMCloud infrastructure provider. properties: cisInstanceCRN: description: |- - CISInstanceCRN is the CRN of the Cloud Internet Services instance managing + 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 + 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 + description: location is where the cluster has been deployed type: string providerType: - description: ProviderType indicates the type of cluster + description: providerType indicates the type of cluster that was created type: string resourceGroupName: - description: ResourceGroupName is the Resource Group + description: resourceGroupName is the Resource Group for new IBMCloud resources created for the cluster. type: string serviceEndpoints: @@ -1917,7 +1917,7 @@ spec: x-kubernetes-list-type: map type: object kubevirt: - description: Kubevirt contains settings specific to the + description: kubevirt contains settings specific to the kubevirt infrastructure provider. properties: apiServerInternalIP: @@ -1934,7 +1934,7 @@ spec: type: string type: object nutanix: - description: Nutanix contains settings specific to the + description: nutanix contains settings specific to the Nutanix infrastructure provider. properties: apiServerInternalIP: @@ -1992,7 +1992,7 @@ spec: : true)' type: object openstack: - description: OpenStack contains settings specific to the + description: openstack contains settings specific to the OpenStack infrastructure provider. properties: apiServerInternalIP: @@ -2107,7 +2107,7 @@ spec: type: string type: object ovirt: - description: Ovirt contains settings specific to the oVirt + description: ovirt contains settings specific to the oVirt infrastructure provider. properties: apiServerInternalIP: @@ -2170,17 +2170,17 @@ spec: type: string type: object powervs: - description: PowerVS contains settings specific to the + description: powervs contains settings specific to the Power Systems Virtual Servers infrastructure provider. properties: cisInstanceCRN: description: |- - CISInstanceCRN is the CRN of the Cloud Internet Services instance managing + 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 + dnsInstanceCRN is the CRN of the DNS Services instance managing the DNS zone for the cluster's base domain type: string region: @@ -2290,7 +2290,7 @@ spec: - External type: string vsphere: - description: VSphere contains settings specific to the + description: vsphere contains settings specific to the VSphere infrastructure provider. properties: apiServerInternalIP: @@ -2396,15 +2396,15 @@ spec: format: byte type: string network: - description: Network contains additional network related information + description: network contains additional network related information nullable: true properties: mtuMigration: - description: MTUMigration contains the MTU migration configuration. + description: mtuMigration contains the MTU migration configuration. nullable: true properties: machine: - description: Machine contains MTU migration configuration + description: machine contains MTU migration configuration for the machine's uplink. properties: from: @@ -2419,7 +2419,7 @@ spec: type: integer type: object network: - description: Network contains MTU migration configuration + description: network contains MTU migration configuration for the default network. properties: from: @@ -2446,7 +2446,7 @@ spec: regeneration if this changes. type: string osImageURL: - description: OSImageURL is the old-format container image that contains + description: osImageURL is the old-format container image that contains the OS update payload. type: string platform: diff --git a/machineconfiguration/v1/zz_generated.featuregated-crd-manifests/controllerconfigs.machineconfiguration.openshift.io/VSphereControlPlaneMachineSet.yaml b/machineconfiguration/v1/zz_generated.featuregated-crd-manifests/controllerconfigs.machineconfiguration.openshift.io/VSphereControlPlaneMachineSet.yaml index 059b36dc7e5..633e6af2385 100644 --- a/machineconfiguration/v1/zz_generated.featuregated-crd-manifests/controllerconfigs.machineconfiguration.openshift.io/VSphereControlPlaneMachineSet.yaml +++ b/machineconfiguration/v1/zz_generated.featuregated-crd-manifests/controllerconfigs.machineconfiguration.openshift.io/VSphereControlPlaneMachineSet.yaml @@ -56,11 +56,11 @@ spec: nullable: true type: string baseOSContainerImage: - description: BaseOSContainerImage is the new-format container image + description: baseOSContainerImage is the new-format container image for operating system updates. type: string baseOSExtensionsContainerImage: - description: BaseOSExtensionsContainerImage is the matching extensions + description: baseOSExtensionsContainerImage is the matching extensions container for the new-format container type: string cloudProviderCAData: @@ -337,7 +337,7 @@ spec: All the clients are expected to use the generated ConfigMap only. properties: key: - description: Key allows pointing to a specific key/value + description: key allows pointing to a specific key/value inside of the configmap. This is useful for logical file references. type: string @@ -350,11 +350,11 @@ spec: infrastructure provider. properties: alibabaCloud: - description: AlibabaCloud contains settings specific to + description: alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. type: object aws: - description: AWS contains settings specific to the Amazon + description: aws contains settings specific to the Amazon Web Services infrastructure provider. properties: serviceEndpoints: @@ -386,11 +386,11 @@ spec: x-kubernetes-list-type: atomic type: object azure: - description: Azure contains settings specific to the Azure + description: azure contains settings specific to the Azure infrastructure provider. type: object baremetal: - description: BareMetal contains settings specific to the + description: baremetal contains settings specific to the BareMetal platform. properties: apiServerInternalIPs: @@ -477,7 +477,7 @@ spec: - message: ingressIPs list is required once set rule: '!has(oldSelf.ingressIPs) || has(self.ingressIPs)' equinixMetal: - description: EquinixMetal contains settings specific to + description: equinixMetal contains settings specific to the Equinix Metal infrastructure provider. type: object external: @@ -488,7 +488,7 @@ spec: platformName: default: Unknown description: |- - PlatformName holds the arbitrary string representing the infrastructure provider name, expected to be set at the installation time. + 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 x-kubernetes-validations: @@ -496,19 +496,19 @@ spec: rule: oldSelf == 'Unknown' || self == oldSelf type: object gcp: - description: GCP contains settings specific to the Google + description: gcp contains settings specific to the Google Cloud Platform infrastructure provider. type: object ibmcloud: - description: IBMCloud contains settings specific to the + description: ibmcloud contains settings specific to the IBMCloud infrastructure provider. type: object kubevirt: - description: Kubevirt contains settings specific to the + description: kubevirt contains settings specific to the kubevirt infrastructure provider. type: object nutanix: - description: Nutanix contains settings specific to the + description: nutanix contains settings specific to the Nutanix infrastructure provider. properties: failureDomains: @@ -697,7 +697,7 @@ spec: - prismElements type: object openstack: - description: OpenStack contains settings specific to the + description: openstack contains settings specific to the OpenStack infrastructure provider. properties: apiServerInternalIPs: @@ -784,11 +784,11 @@ spec: - message: ingressIPs list is required once set rule: '!has(oldSelf.ingressIPs) || has(self.ingressIPs)' ovirt: - description: Ovirt contains settings specific to the oVirt + description: ovirt contains settings specific to the oVirt infrastructure provider. type: object powervs: - description: PowerVS contains settings specific to the + description: powervs contains settings specific to the IBM Power Systems Virtual Servers infrastructure provider. properties: serviceEndpoints: @@ -870,7 +870,7 @@ spec: - External type: string vsphere: - description: VSphere contains settings specific to the + description: vsphere contains settings specific to the VSphere infrastructure provider. properties: apiServerInternalIPs: @@ -952,7 +952,7 @@ spec: minLength: 1 type: string topology: - description: Topology describes a given failure + description: topology describes a given failure domain using vSphere constructs properties: computeCluster: @@ -1402,7 +1402,7 @@ spec: infrastructure provider. properties: alibabaCloud: - description: AlibabaCloud contains settings specific to + description: alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. properties: region: @@ -1446,7 +1446,7 @@ spec: - region type: object aws: - description: AWS contains settings specific to the Amazon + description: aws contains settings specific to the Amazon Web Services infrastructure provider. properties: region: @@ -1487,7 +1487,7 @@ spec: x-kubernetes-list-type: atomic serviceEndpoints: description: |- - ServiceEndpoints list contains custom endpoints which will override default + serviceEndpoints list contains custom endpoints which will override default service endpoint of AWS Services. There must be only one ServiceEndpoint for a service. items: @@ -1514,7 +1514,7 @@ spec: x-kubernetes-list-type: atomic type: object azure: - description: Azure contains settings specific to the Azure + description: azure contains settings specific to the Azure infrastructure provider. properties: armEndpoint: @@ -1590,7 +1590,7 @@ spec: rule: '!has(oldSelf.resourceTags) && !has(self.resourceTags) || has(oldSelf.resourceTags) && has(self.resourceTags)' baremetal: - description: BareMetal contains settings specific to the + description: baremetal contains settings specific to the BareMetal platform. properties: apiServerInternalIP: @@ -1674,7 +1674,7 @@ spec: type: string type: object equinixMetal: - description: EquinixMetal contains settings specific to + description: equinixMetal contains settings specific to the Equinix Metal infrastructure provider. properties: apiServerInternalIP: @@ -1691,7 +1691,7 @@ spec: type: string type: object external: - description: External contains settings specific to the + description: external contains settings specific to the generic External infrastructure provider. properties: cloudControllerManager: @@ -1731,7 +1731,7 @@ spec: removed once set rule: has(self.cloudControllerManager) == has(oldSelf.cloudControllerManager) gcp: - description: GCP contains settings specific to the Google + description: gcp contains settings specific to the Google Cloud Platform infrastructure provider. properties: projectID: @@ -1744,29 +1744,29 @@ spec: type: string type: object ibmcloud: - description: IBMCloud contains settings specific to the + description: ibmcloud contains settings specific to the IBMCloud infrastructure provider. properties: cisInstanceCRN: description: |- - CISInstanceCRN is the CRN of the Cloud Internet Services instance managing + 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 + 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 + description: location is where the cluster has been deployed type: string providerType: - description: ProviderType indicates the type of cluster + description: providerType indicates the type of cluster that was created type: string resourceGroupName: - description: ResourceGroupName is the Resource Group + description: resourceGroupName is the Resource Group for new IBMCloud resources created for the cluster. type: string serviceEndpoints: @@ -1821,7 +1821,7 @@ spec: x-kubernetes-list-type: map type: object kubevirt: - description: Kubevirt contains settings specific to the + description: kubevirt contains settings specific to the kubevirt infrastructure provider. properties: apiServerInternalIP: @@ -1838,7 +1838,7 @@ spec: type: string type: object nutanix: - description: Nutanix contains settings specific to the + description: nutanix contains settings specific to the Nutanix infrastructure provider. properties: apiServerInternalIP: @@ -1896,7 +1896,7 @@ spec: : true)' type: object openstack: - description: OpenStack contains settings specific to the + description: openstack contains settings specific to the OpenStack infrastructure provider. properties: apiServerInternalIP: @@ -2011,7 +2011,7 @@ spec: type: string type: object ovirt: - description: Ovirt contains settings specific to the oVirt + description: ovirt contains settings specific to the oVirt infrastructure provider. properties: apiServerInternalIP: @@ -2074,17 +2074,17 @@ spec: type: string type: object powervs: - description: PowerVS contains settings specific to the + description: powervs contains settings specific to the Power Systems Virtual Servers infrastructure provider. properties: cisInstanceCRN: description: |- - CISInstanceCRN is the CRN of the Cloud Internet Services instance managing + 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 + dnsInstanceCRN is the CRN of the DNS Services instance managing the DNS zone for the cluster's base domain type: string region: @@ -2194,7 +2194,7 @@ spec: - External type: string vsphere: - description: VSphere contains settings specific to the + description: vsphere contains settings specific to the VSphere infrastructure provider. properties: apiServerInternalIP: @@ -2300,15 +2300,15 @@ spec: format: byte type: string network: - description: Network contains additional network related information + description: network contains additional network related information nullable: true properties: mtuMigration: - description: MTUMigration contains the MTU migration configuration. + description: mtuMigration contains the MTU migration configuration. nullable: true properties: machine: - description: Machine contains MTU migration configuration + description: machine contains MTU migration configuration for the machine's uplink. properties: from: @@ -2323,7 +2323,7 @@ spec: type: integer type: object network: - description: Network contains MTU migration configuration + description: network contains MTU migration configuration for the default network. properties: from: @@ -2350,7 +2350,7 @@ spec: regeneration if this changes. type: string osImageURL: - description: OSImageURL is the old-format container image that contains + description: osImageURL is the old-format container image that contains the OS update payload. type: string platform: diff --git a/machineconfiguration/v1/zz_generated.featuregated-crd-manifests/controllerconfigs.machineconfiguration.openshift.io/VSphereMultiNetworks.yaml b/machineconfiguration/v1/zz_generated.featuregated-crd-manifests/controllerconfigs.machineconfiguration.openshift.io/VSphereMultiNetworks.yaml index 55948ecd1ef..9aff5bc5aad 100644 --- a/machineconfiguration/v1/zz_generated.featuregated-crd-manifests/controllerconfigs.machineconfiguration.openshift.io/VSphereMultiNetworks.yaml +++ b/machineconfiguration/v1/zz_generated.featuregated-crd-manifests/controllerconfigs.machineconfiguration.openshift.io/VSphereMultiNetworks.yaml @@ -56,11 +56,11 @@ spec: nullable: true type: string baseOSContainerImage: - description: BaseOSContainerImage is the new-format container image + description: baseOSContainerImage is the new-format container image for operating system updates. type: string baseOSExtensionsContainerImage: - description: BaseOSExtensionsContainerImage is the matching extensions + description: baseOSExtensionsContainerImage is the matching extensions container for the new-format container type: string cloudProviderCAData: @@ -337,7 +337,7 @@ spec: All the clients are expected to use the generated ConfigMap only. properties: key: - description: Key allows pointing to a specific key/value + description: key allows pointing to a specific key/value inside of the configmap. This is useful for logical file references. type: string @@ -350,11 +350,11 @@ spec: infrastructure provider. properties: alibabaCloud: - description: AlibabaCloud contains settings specific to + description: alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. type: object aws: - description: AWS contains settings specific to the Amazon + description: aws contains settings specific to the Amazon Web Services infrastructure provider. properties: serviceEndpoints: @@ -386,11 +386,11 @@ spec: x-kubernetes-list-type: atomic type: object azure: - description: Azure contains settings specific to the Azure + description: azure contains settings specific to the Azure infrastructure provider. type: object baremetal: - description: BareMetal contains settings specific to the + description: baremetal contains settings specific to the BareMetal platform. properties: apiServerInternalIPs: @@ -477,7 +477,7 @@ spec: - message: ingressIPs list is required once set rule: '!has(oldSelf.ingressIPs) || has(self.ingressIPs)' equinixMetal: - description: EquinixMetal contains settings specific to + description: equinixMetal contains settings specific to the Equinix Metal infrastructure provider. type: object external: @@ -488,7 +488,7 @@ spec: platformName: default: Unknown description: |- - PlatformName holds the arbitrary string representing the infrastructure provider name, expected to be set at the installation time. + 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 x-kubernetes-validations: @@ -496,19 +496,19 @@ spec: rule: oldSelf == 'Unknown' || self == oldSelf type: object gcp: - description: GCP contains settings specific to the Google + description: gcp contains settings specific to the Google Cloud Platform infrastructure provider. type: object ibmcloud: - description: IBMCloud contains settings specific to the + description: ibmcloud contains settings specific to the IBMCloud infrastructure provider. type: object kubevirt: - description: Kubevirt contains settings specific to the + description: kubevirt contains settings specific to the kubevirt infrastructure provider. type: object nutanix: - description: Nutanix contains settings specific to the + description: nutanix contains settings specific to the Nutanix infrastructure provider. properties: failureDomains: @@ -697,7 +697,7 @@ spec: - prismElements type: object openstack: - description: OpenStack contains settings specific to the + description: openstack contains settings specific to the OpenStack infrastructure provider. properties: apiServerInternalIPs: @@ -784,11 +784,11 @@ spec: - message: ingressIPs list is required once set rule: '!has(oldSelf.ingressIPs) || has(self.ingressIPs)' ovirt: - description: Ovirt contains settings specific to the oVirt + description: ovirt contains settings specific to the oVirt infrastructure provider. type: object powervs: - description: PowerVS contains settings specific to the + description: powervs contains settings specific to the IBM Power Systems Virtual Servers infrastructure provider. properties: serviceEndpoints: @@ -870,7 +870,7 @@ spec: - External type: string vsphere: - description: VSphere contains settings specific to the + description: vsphere contains settings specific to the VSphere infrastructure provider. properties: apiServerInternalIPs: @@ -952,7 +952,7 @@ spec: minLength: 1 type: string topology: - description: Topology describes a given failure + description: topology describes a given failure domain using vSphere constructs properties: computeCluster: @@ -1388,7 +1388,7 @@ spec: infrastructure provider. properties: alibabaCloud: - description: AlibabaCloud contains settings specific to + description: alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. properties: region: @@ -1432,7 +1432,7 @@ spec: - region type: object aws: - description: AWS contains settings specific to the Amazon + description: aws contains settings specific to the Amazon Web Services infrastructure provider. properties: region: @@ -1473,7 +1473,7 @@ spec: x-kubernetes-list-type: atomic serviceEndpoints: description: |- - ServiceEndpoints list contains custom endpoints which will override default + serviceEndpoints list contains custom endpoints which will override default service endpoint of AWS Services. There must be only one ServiceEndpoint for a service. items: @@ -1500,7 +1500,7 @@ spec: x-kubernetes-list-type: atomic type: object azure: - description: Azure contains settings specific to the Azure + description: azure contains settings specific to the Azure infrastructure provider. properties: armEndpoint: @@ -1576,7 +1576,7 @@ spec: rule: '!has(oldSelf.resourceTags) && !has(self.resourceTags) || has(oldSelf.resourceTags) && has(self.resourceTags)' baremetal: - description: BareMetal contains settings specific to the + description: baremetal contains settings specific to the BareMetal platform. properties: apiServerInternalIP: @@ -1660,7 +1660,7 @@ spec: type: string type: object equinixMetal: - description: EquinixMetal contains settings specific to + description: equinixMetal contains settings specific to the Equinix Metal infrastructure provider. properties: apiServerInternalIP: @@ -1677,7 +1677,7 @@ spec: type: string type: object external: - description: External contains settings specific to the + description: external contains settings specific to the generic External infrastructure provider. properties: cloudControllerManager: @@ -1717,7 +1717,7 @@ spec: removed once set rule: has(self.cloudControllerManager) == has(oldSelf.cloudControllerManager) gcp: - description: GCP contains settings specific to the Google + description: gcp contains settings specific to the Google Cloud Platform infrastructure provider. properties: projectID: @@ -1730,29 +1730,29 @@ spec: type: string type: object ibmcloud: - description: IBMCloud contains settings specific to the + description: ibmcloud contains settings specific to the IBMCloud infrastructure provider. properties: cisInstanceCRN: description: |- - CISInstanceCRN is the CRN of the Cloud Internet Services instance managing + 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 + 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 + description: location is where the cluster has been deployed type: string providerType: - description: ProviderType indicates the type of cluster + description: providerType indicates the type of cluster that was created type: string resourceGroupName: - description: ResourceGroupName is the Resource Group + description: resourceGroupName is the Resource Group for new IBMCloud resources created for the cluster. type: string serviceEndpoints: @@ -1807,7 +1807,7 @@ spec: x-kubernetes-list-type: map type: object kubevirt: - description: Kubevirt contains settings specific to the + description: kubevirt contains settings specific to the kubevirt infrastructure provider. properties: apiServerInternalIP: @@ -1824,7 +1824,7 @@ spec: type: string type: object nutanix: - description: Nutanix contains settings specific to the + description: nutanix contains settings specific to the Nutanix infrastructure provider. properties: apiServerInternalIP: @@ -1882,7 +1882,7 @@ spec: : true)' type: object openstack: - description: OpenStack contains settings specific to the + description: openstack contains settings specific to the OpenStack infrastructure provider. properties: apiServerInternalIP: @@ -1997,7 +1997,7 @@ spec: type: string type: object ovirt: - description: Ovirt contains settings specific to the oVirt + description: ovirt contains settings specific to the oVirt infrastructure provider. properties: apiServerInternalIP: @@ -2060,17 +2060,17 @@ spec: type: string type: object powervs: - description: PowerVS contains settings specific to the + description: powervs contains settings specific to the Power Systems Virtual Servers infrastructure provider. properties: cisInstanceCRN: description: |- - CISInstanceCRN is the CRN of the Cloud Internet Services instance managing + 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 + dnsInstanceCRN is the CRN of the DNS Services instance managing the DNS zone for the cluster's base domain type: string region: @@ -2180,7 +2180,7 @@ spec: - External type: string vsphere: - description: VSphere contains settings specific to the + description: vsphere contains settings specific to the VSphere infrastructure provider. properties: apiServerInternalIP: @@ -2286,15 +2286,15 @@ spec: format: byte type: string network: - description: Network contains additional network related information + description: network contains additional network related information nullable: true properties: mtuMigration: - description: MTUMigration contains the MTU migration configuration. + description: mtuMigration contains the MTU migration configuration. nullable: true properties: machine: - description: Machine contains MTU migration configuration + description: machine contains MTU migration configuration for the machine's uplink. properties: from: @@ -2309,7 +2309,7 @@ spec: type: integer type: object network: - description: Network contains MTU migration configuration + description: network contains MTU migration configuration for the default network. properties: from: @@ -2336,7 +2336,7 @@ spec: regeneration if this changes. type: string osImageURL: - description: OSImageURL is the old-format container image that contains + description: osImageURL is the old-format container image that contains the OS update payload. type: string platform: diff --git a/machineconfiguration/v1/zz_generated.featuregated-crd-manifests/controllerconfigs.machineconfiguration.openshift.io/VSphereMultiVCenters.yaml b/machineconfiguration/v1/zz_generated.featuregated-crd-manifests/controllerconfigs.machineconfiguration.openshift.io/VSphereMultiVCenters.yaml index 071f1405d6b..963b6e40c41 100644 --- a/machineconfiguration/v1/zz_generated.featuregated-crd-manifests/controllerconfigs.machineconfiguration.openshift.io/VSphereMultiVCenters.yaml +++ b/machineconfiguration/v1/zz_generated.featuregated-crd-manifests/controllerconfigs.machineconfiguration.openshift.io/VSphereMultiVCenters.yaml @@ -56,11 +56,11 @@ spec: nullable: true type: string baseOSContainerImage: - description: BaseOSContainerImage is the new-format container image + description: baseOSContainerImage is the new-format container image for operating system updates. type: string baseOSExtensionsContainerImage: - description: BaseOSExtensionsContainerImage is the matching extensions + description: baseOSExtensionsContainerImage is the matching extensions container for the new-format container type: string cloudProviderCAData: @@ -337,7 +337,7 @@ spec: All the clients are expected to use the generated ConfigMap only. properties: key: - description: Key allows pointing to a specific key/value + description: key allows pointing to a specific key/value inside of the configmap. This is useful for logical file references. type: string @@ -350,11 +350,11 @@ spec: infrastructure provider. properties: alibabaCloud: - description: AlibabaCloud contains settings specific to + description: alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. type: object aws: - description: AWS contains settings specific to the Amazon + description: aws contains settings specific to the Amazon Web Services infrastructure provider. properties: serviceEndpoints: @@ -386,11 +386,11 @@ spec: x-kubernetes-list-type: atomic type: object azure: - description: Azure contains settings specific to the Azure + description: azure contains settings specific to the Azure infrastructure provider. type: object baremetal: - description: BareMetal contains settings specific to the + description: baremetal contains settings specific to the BareMetal platform. properties: apiServerInternalIPs: @@ -477,7 +477,7 @@ spec: - message: ingressIPs list is required once set rule: '!has(oldSelf.ingressIPs) || has(self.ingressIPs)' equinixMetal: - description: EquinixMetal contains settings specific to + description: equinixMetal contains settings specific to the Equinix Metal infrastructure provider. type: object external: @@ -488,7 +488,7 @@ spec: platformName: default: Unknown description: |- - PlatformName holds the arbitrary string representing the infrastructure provider name, expected to be set at the installation time. + 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 x-kubernetes-validations: @@ -496,19 +496,19 @@ spec: rule: oldSelf == 'Unknown' || self == oldSelf type: object gcp: - description: GCP contains settings specific to the Google + description: gcp contains settings specific to the Google Cloud Platform infrastructure provider. type: object ibmcloud: - description: IBMCloud contains settings specific to the + description: ibmcloud contains settings specific to the IBMCloud infrastructure provider. type: object kubevirt: - description: Kubevirt contains settings specific to the + description: kubevirt contains settings specific to the kubevirt infrastructure provider. type: object nutanix: - description: Nutanix contains settings specific to the + description: nutanix contains settings specific to the Nutanix infrastructure provider. properties: failureDomains: @@ -697,7 +697,7 @@ spec: - prismElements type: object openstack: - description: OpenStack contains settings specific to the + description: openstack contains settings specific to the OpenStack infrastructure provider. properties: apiServerInternalIPs: @@ -784,11 +784,11 @@ spec: - message: ingressIPs list is required once set rule: '!has(oldSelf.ingressIPs) || has(self.ingressIPs)' ovirt: - description: Ovirt contains settings specific to the oVirt + description: ovirt contains settings specific to the oVirt infrastructure provider. type: object powervs: - description: PowerVS contains settings specific to the + description: powervs contains settings specific to the IBM Power Systems Virtual Servers infrastructure provider. properties: serviceEndpoints: @@ -870,7 +870,7 @@ spec: - External type: string vsphere: - description: VSphere contains settings specific to the + description: vsphere contains settings specific to the VSphere infrastructure provider. properties: apiServerInternalIPs: @@ -952,7 +952,7 @@ spec: minLength: 1 type: string topology: - description: Topology describes a given failure + description: topology describes a given failure domain using vSphere constructs properties: computeCluster: @@ -1388,7 +1388,7 @@ spec: infrastructure provider. properties: alibabaCloud: - description: AlibabaCloud contains settings specific to + description: alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. properties: region: @@ -1432,7 +1432,7 @@ spec: - region type: object aws: - description: AWS contains settings specific to the Amazon + description: aws contains settings specific to the Amazon Web Services infrastructure provider. properties: region: @@ -1473,7 +1473,7 @@ spec: x-kubernetes-list-type: atomic serviceEndpoints: description: |- - ServiceEndpoints list contains custom endpoints which will override default + serviceEndpoints list contains custom endpoints which will override default service endpoint of AWS Services. There must be only one ServiceEndpoint for a service. items: @@ -1500,7 +1500,7 @@ spec: x-kubernetes-list-type: atomic type: object azure: - description: Azure contains settings specific to the Azure + description: azure contains settings specific to the Azure infrastructure provider. properties: armEndpoint: @@ -1576,7 +1576,7 @@ spec: rule: '!has(oldSelf.resourceTags) && !has(self.resourceTags) || has(oldSelf.resourceTags) && has(self.resourceTags)' baremetal: - description: BareMetal contains settings specific to the + description: baremetal contains settings specific to the BareMetal platform. properties: apiServerInternalIP: @@ -1660,7 +1660,7 @@ spec: type: string type: object equinixMetal: - description: EquinixMetal contains settings specific to + description: equinixMetal contains settings specific to the Equinix Metal infrastructure provider. properties: apiServerInternalIP: @@ -1677,7 +1677,7 @@ spec: type: string type: object external: - description: External contains settings specific to the + description: external contains settings specific to the generic External infrastructure provider. properties: cloudControllerManager: @@ -1717,7 +1717,7 @@ spec: removed once set rule: has(self.cloudControllerManager) == has(oldSelf.cloudControllerManager) gcp: - description: GCP contains settings specific to the Google + description: gcp contains settings specific to the Google Cloud Platform infrastructure provider. properties: projectID: @@ -1730,29 +1730,29 @@ spec: type: string type: object ibmcloud: - description: IBMCloud contains settings specific to the + description: ibmcloud contains settings specific to the IBMCloud infrastructure provider. properties: cisInstanceCRN: description: |- - CISInstanceCRN is the CRN of the Cloud Internet Services instance managing + 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 + 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 + description: location is where the cluster has been deployed type: string providerType: - description: ProviderType indicates the type of cluster + description: providerType indicates the type of cluster that was created type: string resourceGroupName: - description: ResourceGroupName is the Resource Group + description: resourceGroupName is the Resource Group for new IBMCloud resources created for the cluster. type: string serviceEndpoints: @@ -1807,7 +1807,7 @@ spec: x-kubernetes-list-type: map type: object kubevirt: - description: Kubevirt contains settings specific to the + description: kubevirt contains settings specific to the kubevirt infrastructure provider. properties: apiServerInternalIP: @@ -1824,7 +1824,7 @@ spec: type: string type: object nutanix: - description: Nutanix contains settings specific to the + description: nutanix contains settings specific to the Nutanix infrastructure provider. properties: apiServerInternalIP: @@ -1882,7 +1882,7 @@ spec: : true)' type: object openstack: - description: OpenStack contains settings specific to the + description: openstack contains settings specific to the OpenStack infrastructure provider. properties: apiServerInternalIP: @@ -1997,7 +1997,7 @@ spec: type: string type: object ovirt: - description: Ovirt contains settings specific to the oVirt + description: ovirt contains settings specific to the oVirt infrastructure provider. properties: apiServerInternalIP: @@ -2060,17 +2060,17 @@ spec: type: string type: object powervs: - description: PowerVS contains settings specific to the + description: powervs contains settings specific to the Power Systems Virtual Servers infrastructure provider. properties: cisInstanceCRN: description: |- - CISInstanceCRN is the CRN of the Cloud Internet Services instance managing + 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 + dnsInstanceCRN is the CRN of the DNS Services instance managing the DNS zone for the cluster's base domain type: string region: @@ -2180,7 +2180,7 @@ spec: - External type: string vsphere: - description: VSphere contains settings specific to the + description: vsphere contains settings specific to the VSphere infrastructure provider. properties: apiServerInternalIP: @@ -2286,15 +2286,15 @@ spec: format: byte type: string network: - description: Network contains additional network related information + description: network contains additional network related information nullable: true properties: mtuMigration: - description: MTUMigration contains the MTU migration configuration. + description: mtuMigration contains the MTU migration configuration. nullable: true properties: machine: - description: Machine contains MTU migration configuration + description: machine contains MTU migration configuration for the machine's uplink. properties: from: @@ -2309,7 +2309,7 @@ spec: type: integer type: object network: - description: Network contains MTU migration configuration + description: network contains MTU migration configuration for the default network. properties: from: @@ -2336,7 +2336,7 @@ spec: regeneration if this changes. type: string osImageURL: - description: OSImageURL is the old-format container image that contains + description: osImageURL is the old-format container image that contains the OS update payload. type: string platform: diff --git a/machineconfiguration/v1/zz_generated.featuregated-crd-manifests/kubeletconfigs.machineconfiguration.openshift.io/AAA_ungated.yaml b/machineconfiguration/v1/zz_generated.featuregated-crd-manifests/kubeletconfigs.machineconfiguration.openshift.io/AAA_ungated.yaml index b78f35e9f95..fca317f035f 100644 --- a/machineconfiguration/v1/zz_generated.featuregated-crd-manifests/kubeletconfigs.machineconfiguration.openshift.io/AAA_ungated.yaml +++ b/machineconfiguration/v1/zz_generated.featuregated-crd-manifests/kubeletconfigs.machineconfiguration.openshift.io/AAA_ungated.yaml @@ -62,7 +62,7 @@ spec: type: integer machineConfigPoolSelector: description: |- - MachineConfigPoolSelector selects which pools the KubeletConfig shoud apply to. + machineConfigPoolSelector selects which pools the KubeletConfig shoud apply to. A nil selector will result in no pools being selected. properties: matchExpressions: diff --git a/machineconfiguration/v1/zz_generated.featuregated-crd-manifests/machineconfigs.machineconfiguration.openshift.io/AAA_ungated.yaml b/machineconfiguration/v1/zz_generated.featuregated-crd-manifests/machineconfigs.machineconfiguration.openshift.io/AAA_ungated.yaml index 4ff44154163..93b10fd2f4d 100644 --- a/machineconfiguration/v1/zz_generated.featuregated-crd-manifests/machineconfigs.machineconfiguration.openshift.io/AAA_ungated.yaml +++ b/machineconfiguration/v1/zz_generated.featuregated-crd-manifests/machineconfigs.machineconfiguration.openshift.io/AAA_ungated.yaml @@ -64,11 +64,11 @@ spec: properties: baseOSExtensionsContainerImage: description: |- - BaseOSExtensionsContainerImage specifies the remote location that will be used + baseOSExtensionsContainerImage specifies the remote location that will be used to fetch the extensions container matching a new-format OS image type: string config: - description: Config is a Ignition Config object. + description: config is a Ignition Config object. type: object x-kubernetes-preserve-unknown-fields: true extensions: @@ -96,7 +96,7 @@ spec: type: string osImageURL: description: |- - OSImageURL specifies the remote location that will be used to + osImageURL specifies the remote location that will be used to fetch the OS. type: string type: object diff --git a/machineconfiguration/v1/zz_generated.swagger_doc_generated.go b/machineconfiguration/v1/zz_generated.swagger_doc_generated.go index 29a3a2a902b..b4fdfcd506f 100644 --- a/machineconfiguration/v1/zz_generated.swagger_doc_generated.go +++ b/machineconfiguration/v1/zz_generated.swagger_doc_generated.go @@ -53,7 +53,7 @@ func (ContainerRuntimeConfigList) SwaggerDoc() map[string]string { var map_ContainerRuntimeConfigSpec = map[string]string{ "": "ContainerRuntimeConfigSpec defines the desired state of ContainerRuntimeConfig", - "machineConfigPoolSelector": "MachineConfigPoolSelector selects which pools the ContainerRuntimeConfig shoud apply to. A nil selector will result in no pools being selected.", + "machineConfigPoolSelector": "machineConfigPoolSelector selects which pools the ContainerRuntimeConfig shoud apply to. A nil selector will result in no pools being selected.", } func (ContainerRuntimeConfigSpec) SwaggerDoc() map[string]string { @@ -127,16 +127,16 @@ var map_ControllerConfigSpec = map[string]string{ "pullSecret": "pullSecret is the default pull secret that needs to be installed on all machines.", "internalRegistryPullSecret": "internalRegistryPullSecret is the pull secret for the internal registry, used by rpm-ostree to pull images from the internal registry if present", "images": "images is map of images that are used by the controller to render templates under ./templates/", - "baseOSContainerImage": "BaseOSContainerImage is the new-format container image for operating system updates.", - "baseOSExtensionsContainerImage": "BaseOSExtensionsContainerImage is the matching extensions container for the new-format container", - "osImageURL": "OSImageURL is the old-format container image that contains the OS update payload.", + "baseOSContainerImage": "baseOSContainerImage is the new-format container image for operating system updates.", + "baseOSExtensionsContainerImage": "baseOSExtensionsContainerImage is the matching extensions container for the new-format container", + "osImageURL": "osImageURL is the old-format container image that contains the OS update payload.", "releaseImage": "releaseImage is the image used when installing the cluster", "proxy": "proxy holds the current proxy configuration for the nodes", "infra": "infra holds the infrastructure details", "dns": "dns holds the cluster dns details", "ipFamilies": "ipFamilies indicates the IP families in use by the cluster network", "networkType": "networkType holds the type of network the cluster is using XXX: this is temporary and will be dropped as soon as possible in favor of a better support to start network related services the proper way. Nobody is also changing this once the cluster is up and running the first time, so, disallow regeneration if this changes.", - "network": "Network contains additional network related information", + "network": "network contains additional network related information", } func (ControllerConfigSpec) SwaggerDoc() map[string]string { @@ -208,7 +208,7 @@ func (KubeletConfigList) SwaggerDoc() map[string]string { var map_KubeletConfigSpec = map[string]string{ "": "KubeletConfigSpec defines the desired state of KubeletConfig", - "machineConfigPoolSelector": "MachineConfigPoolSelector selects which pools the KubeletConfig shoud apply to. A nil selector will result in no pools being selected.", + "machineConfigPoolSelector": "machineConfigPoolSelector selects which pools the KubeletConfig shoud apply to. A nil selector will result in no pools being selected.", "kubeletConfig": "kubeletConfig fields are defined in kubernetes upstream. Please refer to the types defined in the version/commit used by OpenShift of the upstream kubernetes. It's important to note that, since the fields of the kubelet configuration are directly fetched from upstream the validation of those values is handled directly by the kubelet. Please refer to the upstream version of the relevant kubernetes for the valid values of these fields. Invalid values of the kubelet configuration fields may render cluster nodes unusable.", "tlsSecurityProfile": "If unset, the default is based on the apiservers.config.openshift.io/cluster resource. Note that only Old and Intermediate profiles are currently supported, and the maximum available minTLSVersion is VersionTLS12.", } @@ -315,9 +315,9 @@ func (MachineConfigPoolStatusConfiguration) SwaggerDoc() map[string]string { var map_MachineConfigSpec = map[string]string{ "": "MachineConfigSpec is the spec for MachineConfig", - "osImageURL": "OSImageURL specifies the remote location that will be used to fetch the OS.", - "baseOSExtensionsContainerImage": "BaseOSExtensionsContainerImage specifies the remote location that will be used to fetch the extensions container matching a new-format OS image", - "config": "Config is a Ignition Config object.", + "osImageURL": "osImageURL specifies the remote location that will be used to fetch the OS.", + "baseOSExtensionsContainerImage": "baseOSExtensionsContainerImage specifies the remote location that will be used to fetch the extensions container matching a new-format OS image", + "config": "config is a Ignition Config object.", "kernelArguments": "kernelArguments contains a list of kernel arguments to be added", "extensions": "extensions contains a list of additional features that can be enabled on host", "fips": "fips controls FIPS mode", @@ -330,7 +330,7 @@ func (MachineConfigSpec) SwaggerDoc() map[string]string { var map_NetworkInfo = map[string]string{ "": "Network contains network related configuration", - "mtuMigration": "MTUMigration contains the MTU migration configuration.", + "mtuMigration": "mtuMigration contains the MTU migration configuration.", } func (NetworkInfo) SwaggerDoc() map[string]string { diff --git a/machineconfiguration/v1alpha1/types_machineconfignode.go b/machineconfiguration/v1alpha1/types_machineconfignode.go index 98b3c48f713..050b5f683e9 100644 --- a/machineconfiguration/v1alpha1/types_machineconfignode.go +++ b/machineconfiguration/v1alpha1/types_machineconfignode.go @@ -40,7 +40,7 @@ type MachineConfigNode struct { metav1.ObjectMeta `json:"metadata,omitempty"` // spec describes the configuration of the machine config node. - // +kubebuilder:validation:Required + // +required Spec MachineConfigNodeSpec `json:"spec"` // status describes the last observed state of this machine config node. @@ -70,25 +70,25 @@ type MCOObjectReference struct { // and must be at most 253 characters in length. // +kubebuilder:validation:MaxLength:=253 // +kubebuilder:validation:Pattern=`^([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]{0,61}[a-zA-Z0-9])(\.([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]{0,61}[a-zA-Z0-9]))*$` - // +kubebuilder:validation:Required + // +required Name string `json:"name"` } // MachineConfigNodeSpec describes the MachineConfigNode we are managing. type MachineConfigNodeSpec struct { // node contains a reference to the node for this machine config node. - // +kubebuilder:validation:Required + // +required Node MCOObjectReference `json:"node"` // pool contains a reference to the machine config pool that this machine config node's // referenced node belongs to. - // +kubebuilder:validation:Required + // +required Pool MCOObjectReference `json:"pool"` // 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. This gets set before the machine config operator validates // the new machine config against the current machine config. - // +kubebuilder:validation:Required + // +required ConfigVersion MachineConfigNodeSpecMachineConfigVersion `json:"configVersion"` // pinnedImageSets holds the desired pinned image sets that this node should pin and pull. @@ -109,13 +109,13 @@ type MachineConfigNodeStatus struct { Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type"` // observedGeneration represents the generation observed by the controller. // This field is updated when the controller observes a change to the desiredConfig in the configVersion of the machine config node spec. - // +kubebuilder:validation:Required + // +required ObservedGeneration int64 `json:"observedGeneration,omitempty"` // configVersion describes the current and desired machine config for this node. // The current version represents the current machine config for the node and is updated after a successful update. // The desired version represents the machine config the node will attempt to update to. // This desired machine config has been compared to the current machine config and has been validated by the machine config operator as one that is valid and that exists. - // +kubebuilder:validation:Required + // +required ConfigVersion MachineConfigNodeStatusMachineConfigVersion `json:"configVersion"` // pinnedImageSets describes the current and desired pinned image sets for this node. // The current version is the generation of the pinned image set that has most recently been successfully pulled and pinned on this node. @@ -137,7 +137,7 @@ type MachineConfigNodeStatusPinnedImageSet struct { // and must be at most 253 characters in length. // +kubebuilder:validation:MaxLength:=253 // +kubebuilder:validation:Pattern=`^([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]{0,61}[a-zA-Z0-9])(\.([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]{0,61}[a-zA-Z0-9]))*$` - // +kubebuilder:validation:Required + // +required Name string `json:"name"` // currentGeneration is the generation of the pinned image set that has most recently been successfully pulled and pinned on this node. // +optional @@ -180,7 +180,7 @@ type MachineConfigNodeStatusMachineConfigVersion struct { // and must be at most 253 characters in length. // +kubebuilder:validation:MaxLength=253 // +kubebuilder:validation:Pattern=`^([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]{0,61}[a-zA-Z0-9])(\.([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]{0,61}[a-zA-Z0-9]))*$` - // +kubebuilder:validation:Required + // +required Desired string `json:"desired"` } @@ -198,7 +198,7 @@ type MachineConfigNodeSpecMachineConfigVersion struct { // and must be at most 253 characters in length. // +kubebuilder:validation:MaxLength=253 // +kubebuilder:validation:Pattern=`^([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]{0,61}[a-zA-Z0-9])(\.([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]{0,61}[a-zA-Z0-9]))*$` - // +kubebuilder:validation:Required + // +required Desired string `json:"desired"` } @@ -209,7 +209,7 @@ type MachineConfigNodeSpecPinnedImageSet struct { // and must be at most 253 characters in length. // +kubebuilder:validation:MaxLength:=253 // +kubebuilder:validation:Pattern=`^([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]{0,61}[a-zA-Z0-9])(\.([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]{0,61}[a-zA-Z0-9]))*$` - // +kubebuilder:validation:Required + // +required Name string `json:"name"` } diff --git a/machineconfiguration/v1alpha1/types_machineosbuild.go b/machineconfiguration/v1alpha1/types_machineosbuild.go index 82ae150c825..d65fd4bce05 100644 --- a/machineconfiguration/v1alpha1/types_machineosbuild.go +++ b/machineconfiguration/v1alpha1/types_machineosbuild.go @@ -29,7 +29,7 @@ type MachineOSBuild struct { // spec describes the configuration of the machine os build // +kubebuilder:validation:XValidation:rule="self == oldSelf",message="machineOSBuildSpec is immutable once set" - // +kubebuilder:validation:Required + // +required Spec MachineOSBuildSpec `json:"spec"` // status describes the lst observed state of this machine os build @@ -54,17 +54,17 @@ type MachineOSBuildList struct { type MachineOSBuildSpec struct { // configGeneration tracks which version of MachineOSConfig this build is based off of // +kubebuilder:validation:Minimum=1 - // +kubebuilder:validation:Required + // +required ConfigGeneration int64 `json:"configGeneration"` // desiredConfig is the desired config we want to build an image for. - // +kubebuilder:validation:Required + // +required DesiredConfig RenderedMachineConfigReference `json:"desiredConfig"` // machineOSConfig is the config object which the build is based off of - // +kubebuilder:validation:Required + // +required MachineOSConfig MachineOSConfigReference `json:"machineOSConfig"` // version tracks the newest MachineOSBuild for each MachineOSConfig // +kubebuilder:validation:Minimum=1 - // +kubebuilder:validation:Required + // +required Version int64 `json:"version"` // renderedImagePushspec is set from the MachineOSConfig // The format of the image pullspec is: @@ -73,7 +73,7 @@ type MachineOSBuildSpec struct { // +kubebuilder:validation:MaxLength=447 // +kubebuilder:validation:XValidation:rule=`((self.split(':').size() == 2 && self.split(':')[1].matches('^([a-zA-Z0-9-./:])+$')) || self.matches('^[^.]+\\.[^.]+\\.svc:\\d+\\/[^\\/]+\\/[^\\/]+:[^\\/]+$'))`,message="the OCI Image reference must end with a valid :, where '' is 64 characters long and '' is any valid string Or it must be a valid .svc followed by a port, repository, image name, and tag." // +kubebuilder:validation:XValidation:rule=`((self.split(':').size() == 2 && self.split(':')[0].matches('^([a-zA-Z0-9-]+\\.)+[a-zA-Z0-9-]+(:[0-9]{2,5})?/([a-zA-Z0-9-_]{0,61}/)?[a-zA-Z0-9-_.]*?$')) || self.matches('^[^.]+\\.[^.]+\\.svc:\\d+\\/[^\\/]+\\/[^\\/]+:[^\\/]+$'))`,message="the OCI Image name should follow the host[:port][/namespace]/name format, resembling a valid URL without the scheme. Or it must be a valid .svc followed by a port, repository, image name, and tag." - // +kubebuilder:validation:Required + // +required RenderedImagePushspec string `json:"renderedImagePushspec"` } @@ -95,7 +95,7 @@ type MachineOSBuildStatus struct { RelatedObjects []ObjectReference `json:"relatedObjects,omitempty"` // buildStart describes when the build started. // +kubebuilder:validation:XValidation:rule="self == oldSelf",message="buildStart is immutable once set" - // +kubebuilder:validation:Required + // +required BuildStart *metav1.Time `json:"buildStart"` // buildEnd describes when the build ended. // +kubebuilder:validation:XValidation:rule="self == oldSelf",message="buildEnd is immutable once set" @@ -111,7 +111,7 @@ type MachineOSBuildStatus struct { // +union // +kubebuilder:validation:XValidation:rule="has(self.imageBuilderType) && self.imageBuilderType == 'PodImageBuilder' ? true : !has(self.buildPod)",message="buildPod is required when imageBuilderType is PodImageBuilder, and forbidden otherwise" type MachineOSBuilderReference struct { - // ImageBuilderType describes the image builder set in the MachineOSConfig + // imageBuilderType describes the image builder set in the MachineOSConfig // +unionDiscriminator ImageBuilderType MachineOSImageBuilderType `json:"imageBuilderType"` @@ -143,29 +143,29 @@ type RenderedMachineConfigReference struct { // name is the name of the rendered MachineConfig object. // +kubebuilder:validation:MaxLength:=253 // +kubebuilder:validation:Pattern=`^([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]{0,61}[a-zA-Z0-9])(\.([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]{0,61}[a-zA-Z0-9]))*$` - // +kubebuilder:validation:Required + // +required Name string `json:"name"` } // ObjectReference contains enough information to let you inspect or modify the referred object. type ObjectReference struct { // group of the referent. - // +kubebuilder:validation:Required + // +required Group string `json:"group"` // resource of the referent. - // +kubebuilder:validation:Required + // +required Resource string `json:"resource"` // namespace of the referent. // +optional Namespace string `json:"namespace,omitempty"` // name of the referent. - // +kubebuilder:validation:Required + // +required Name string `json:"name"` } // MachineOSConfigReference refers to the MachineOSConfig this build is based off of type MachineOSConfigReference struct { // name of the MachineOSConfig - // +kubebuilder:validation:Required + // +required Name string `json:"name"` } diff --git a/machineconfiguration/v1alpha1/types_machineosconfig.go b/machineconfiguration/v1alpha1/types_machineosconfig.go index 35863517a54..1d9f36c36be 100644 --- a/machineconfiguration/v1alpha1/types_machineosconfig.go +++ b/machineconfiguration/v1alpha1/types_machineosconfig.go @@ -23,7 +23,7 @@ type MachineOSConfig struct { metav1.ObjectMeta `json:"metadata,omitempty"` // spec describes the configuration of the machineosconfig - // +kubebuilder:validation:Required + // +required Spec MachineOSConfigSpec `json:"spec"` // status describes the status of the machineosconfig @@ -47,10 +47,10 @@ type MachineOSConfigList struct { // MachineOSConfigSpec describes user-configurable options as well as information about a build process. type MachineOSConfigSpec struct { // machineConfigPool is the pool which the build is for - // +kubebuilder:validation:Required + // +required MachineConfigPool MachineConfigPoolReference `json:"machineConfigPool"` // buildInputs is where user input options for the build live - // +kubebuilder:validation:Required + // +required BuildInputs BuildInputs `json:"buildInputs"` // buildOutputs is where user input options for the build live // +optional @@ -68,7 +68,7 @@ type MachineOSConfigStatus struct { Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type"` // observedGeneration represents the generation observed by the controller. // this field is updated when the user changes the configuration in BuildSettings or the MCP this object is associated with. - // +kubebuilder:validation:Required + // +required ObservedGeneration int64 `json:"observedGeneration,omitempty"` // currentImagePullspec is the fully qualified image pull spec used by the MCO to pull down the new OSImage. This must include sha256. // +kubebuilder:validation:MinLength=1 @@ -105,10 +105,10 @@ type BuildInputs struct { BaseOSImagePullspec string `json:"baseOSImagePullspec,omitempty"` // baseImagePullSecret is the secret used to pull the base image. // must live in the openshift-machine-config-operator namespace - // +kubebuilder:validation:Required + // +required BaseImagePullSecret ImageSecretObjectReference `json:"baseImagePullSecret"` // machineOSImageBuilder describes which image builder will be used in each build triggered by this MachineOSConfig - // +kubebuilder:validation:Required + // +required ImageBuilder *MachineOSImageBuilder `json:"imageBuilder"` // renderedImagePushSecret is the secret used to connect to a user registry. // the final image push and pull secrets should be separate for security concerns. If the final image push secret is somehow exfiltrated, @@ -116,7 +116,7 @@ type BuildInputs struct { // that only gives someone to pull images from the image repository. It's basically the principle of least permissions. // this push secret will be used only by the MachineConfigController pod to push the image to the final destination. Not all nodes will need to push this image, most of them // will only need to pull the image in order to use it. - // +kubebuilder:validation:Required + // +required RenderedImagePushSecret ImageSecretObjectReference `json:"renderedImagePushSecret"` // renderedImagePushspec describes the location of the final image. // the MachineOSConfig object will use the in cluster image registry configuration. @@ -127,7 +127,7 @@ type BuildInputs struct { // +kubebuilder:validation:MaxLength=447 // +kubebuilder:validation:XValidation:rule=`((self.split(':').size() == 2 && self.split(':')[1].matches('^([a-zA-Z0-9-./:])+$')) || self.matches('^[^.]+\\.[^.]+\\.svc:\\d+\\/[^\\/]+\\/[^\\/]+:[^\\/]+$'))`,message="the OCI Image reference must end with a valid :, where '' is 64 characters long and '' is any valid string Or it must be a valid .svc followed by a port, repository, image name, and tag." // +kubebuilder:validation:XValidation:rule=`((self.split(':').size() == 2 && self.split(':')[0].matches('^([a-zA-Z0-9-]+\\.)+[a-zA-Z0-9-]+(:[0-9]{2,5})?/([a-zA-Z0-9-_]{0,61}/)?[a-zA-Z0-9-_.]*?$')) || self.matches('^[^.]+\\.[^.]+\\.svc:\\d+\\/[^\\/]+\\/[^\\/]+:[^\\/]+$'))`,message="the OCI Image name should follow the host[:port][/namespace]/name format, resembling a valid URL without the scheme. Or it must be a valid .svc followed by a port, repository, image name, and tag." - // +kubebuilder:validation:Required + // +required RenderedImagePushspec string `json:"renderedImagePushspec"` // releaseVersion is associated with the base OS Image. This is the version of Openshift that the Base Image is associated with. // This field is populated from the machine-config-osimageurl configmap in the openshift-machine-config-operator namespace. @@ -178,7 +178,7 @@ type MachineOSContainerfile struct { // +optional ContainerfileArch ContainerfileArch `json:"containerfileArch"` // content is the custom content to be built - // +kubebuilder:validation:Required + // +required Content string `json:"content"` } @@ -207,7 +207,7 @@ type MachineConfigPoolReference struct { // name of the MachineConfigPool object. // +kubebuilder:validation:MaxLength:=253 // +kubebuilder:validation:Pattern=`^([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]{0,61}[a-zA-Z0-9])(\.([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]{0,61}[a-zA-Z0-9]))*$` - // +kubebuilder:validation:Required + // +required Name string `json:"name"` } @@ -215,7 +215,7 @@ type MachineConfigPoolReference struct { type ImageSecretObjectReference struct { // name is the name of the secret used to push or pull this MachineOSConfig object. // this secret must be in the openshift-machine-config-operator namespace. - // +kubebuilder:validation:Required + // +required Name string `json:"name"` } diff --git a/machineconfiguration/v1alpha1/types_pinnedimageset.go b/machineconfiguration/v1alpha1/types_pinnedimageset.go index 2718d98deb8..9d097311ddc 100644 --- a/machineconfiguration/v1alpha1/types_pinnedimageset.go +++ b/machineconfiguration/v1alpha1/types_pinnedimageset.go @@ -25,7 +25,7 @@ type PinnedImageSet struct { metav1.ObjectMeta `json:"metadata,omitempty"` // spec describes the configuration of this pinned image set. - // +kubebuilder:validation:Required + // +required Spec PinnedImageSetSpec `json:"spec"` // status describes the last observed state of this pinned image set. @@ -58,7 +58,7 @@ type PinnedImageSetSpec struct { // ] // // These image references should all be by digest, tags aren't allowed. - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:MinItems=1 // +kubebuilder:validation:MaxItems=500 // +listType=map @@ -71,7 +71,7 @@ type PinnedImageRef struct { // // The format of the image ref is: // host[:port][/namespace]/name@sha256: - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=447 // +kubebuilder:validation:XValidation:rule=`self.split('@').size() == 2 && self.split('@')[1].matches('^sha256:[a-f0-9]{64}$')`,message="the OCI Image reference must end with a valid '@sha256:' suffix, where '' is 64 characters long" diff --git a/machineconfiguration/v1alpha1/zz_generated.crd-manifests/0000_80_machine-config_01_machineosbuilds-CustomNoUpgrade.crd.yaml b/machineconfiguration/v1alpha1/zz_generated.crd-manifests/0000_80_machine-config_01_machineosbuilds-CustomNoUpgrade.crd.yaml index aee396dfe32..b153e19ba28 100644 --- a/machineconfiguration/v1alpha1/zz_generated.crd-manifests/0000_80_machine-config_01_machineosbuilds-CustomNoUpgrade.crd.yaml +++ b/machineconfiguration/v1alpha1/zz_generated.crd-manifests/0000_80_machine-config_01_machineosbuilds-CustomNoUpgrade.crd.yaml @@ -170,7 +170,7 @@ spec: - resource type: object imageBuilderType: - description: ImageBuilderType describes the image builder set + description: imageBuilderType describes the image builder set in the MachineOSConfig type: string required: diff --git a/machineconfiguration/v1alpha1/zz_generated.crd-manifests/0000_80_machine-config_01_machineosbuilds-DevPreviewNoUpgrade.crd.yaml b/machineconfiguration/v1alpha1/zz_generated.crd-manifests/0000_80_machine-config_01_machineosbuilds-DevPreviewNoUpgrade.crd.yaml index 4cf5f001636..d64704b194e 100644 --- a/machineconfiguration/v1alpha1/zz_generated.crd-manifests/0000_80_machine-config_01_machineosbuilds-DevPreviewNoUpgrade.crd.yaml +++ b/machineconfiguration/v1alpha1/zz_generated.crd-manifests/0000_80_machine-config_01_machineosbuilds-DevPreviewNoUpgrade.crd.yaml @@ -170,7 +170,7 @@ spec: - resource type: object imageBuilderType: - description: ImageBuilderType describes the image builder set + description: imageBuilderType describes the image builder set in the MachineOSConfig type: string required: diff --git a/machineconfiguration/v1alpha1/zz_generated.crd-manifests/0000_80_machine-config_01_machineosbuilds-TechPreviewNoUpgrade.crd.yaml b/machineconfiguration/v1alpha1/zz_generated.crd-manifests/0000_80_machine-config_01_machineosbuilds-TechPreviewNoUpgrade.crd.yaml index 0e2fe374f10..886173c58e3 100644 --- a/machineconfiguration/v1alpha1/zz_generated.crd-manifests/0000_80_machine-config_01_machineosbuilds-TechPreviewNoUpgrade.crd.yaml +++ b/machineconfiguration/v1alpha1/zz_generated.crd-manifests/0000_80_machine-config_01_machineosbuilds-TechPreviewNoUpgrade.crd.yaml @@ -170,7 +170,7 @@ spec: - resource type: object imageBuilderType: - description: ImageBuilderType describes the image builder set + description: imageBuilderType describes the image builder set in the MachineOSConfig type: string required: diff --git a/machineconfiguration/v1alpha1/zz_generated.featuregated-crd-manifests/machineosbuilds.machineconfiguration.openshift.io/OnClusterBuild.yaml b/machineconfiguration/v1alpha1/zz_generated.featuregated-crd-manifests/machineosbuilds.machineconfiguration.openshift.io/OnClusterBuild.yaml index 1b8a728d4a1..75b7e72cc90 100644 --- a/machineconfiguration/v1alpha1/zz_generated.featuregated-crd-manifests/machineosbuilds.machineconfiguration.openshift.io/OnClusterBuild.yaml +++ b/machineconfiguration/v1alpha1/zz_generated.featuregated-crd-manifests/machineosbuilds.machineconfiguration.openshift.io/OnClusterBuild.yaml @@ -170,7 +170,7 @@ spec: - resource type: object imageBuilderType: - description: ImageBuilderType describes the image builder set + description: imageBuilderType describes the image builder set in the MachineOSConfig type: string required: diff --git a/machineconfiguration/v1alpha1/zz_generated.swagger_doc_generated.go b/machineconfiguration/v1alpha1/zz_generated.swagger_doc_generated.go index a51ffee1426..f2592eaf731 100644 --- a/machineconfiguration/v1alpha1/zz_generated.swagger_doc_generated.go +++ b/machineconfiguration/v1alpha1/zz_generated.swagger_doc_generated.go @@ -148,7 +148,7 @@ func (MachineOSBuildStatus) SwaggerDoc() map[string]string { var map_MachineOSBuilderReference = map[string]string{ "": "MachineOSBuilderReference describes which ImageBuilder backend to use for this build/", - "imageBuilderType": "ImageBuilderType describes the image builder set in the MachineOSConfig", + "imageBuilderType": "imageBuilderType describes the image builder set in the MachineOSConfig", "buildPod": "relatedObjects is a list of objects that are related to the build process.", } diff --git a/monitoring/v1/types.go b/monitoring/v1/types.go index 111538ba78f..2beb04086b4 100644 --- a/monitoring/v1/types.go +++ b/monitoring/v1/types.go @@ -44,7 +44,7 @@ type AlertingRule struct { metav1.ObjectMeta `json:"metadata,omitempty"` // spec describes the desired state of this AlertingRule object. - // +kubebuilder:validation:Required + // +required Spec AlertingRuleSpec `json:"spec"` // status describes the current state of this AlertOverrides object. @@ -67,7 +67,7 @@ type AlertingRuleList struct { metav1.ListMeta `json:"metadata,omitempty"` // items is a list of AlertingRule objects. - // +kubebuilder:validation:Required + // +required Items []AlertingRule `json:"items"` } @@ -93,7 +93,7 @@ type AlertingRuleSpec struct { // +listType=map // +listMapKey=name // +kubebuilder:validation:MinItems:=1 - // +kubebuilder:validation:Required + // +required Groups []RuleGroup `json:"groups"` } @@ -110,7 +110,7 @@ type Duration string type RuleGroup struct { // name is the name of the group. // - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=2048 Name string `json:"name"` @@ -130,7 +130,7 @@ type RuleGroup struct { // processed sequentially, and all rules are processed. // // +kubebuilder:validation:MinItems:=1 - // +kubebuilder:validation:Required + // +required Rules []Rule `json:"rules"` } @@ -143,7 +143,7 @@ type Rule struct { // alert is the name of the alert. Must be a valid label value, i.e. may // contain any Unicode character. // - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=2048 Alert string `json:"alert"` @@ -157,7 +157,7 @@ type Rule struct { // to create an always-firing "Watchdog" alert in order to ensure the alerting // pipeline is functional. // - // +kubebuilder:validation:Required + // +required Expr intstr.IntOrString `json:"expr"` // for is the time period after which alerts are considered firing after first @@ -210,7 +210,7 @@ type PrometheusRuleRef struct { // the reference should we ever need to. // name of the referenced PrometheusRule. - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=2048 Name string `json:"name"` @@ -238,7 +238,7 @@ type AlertRelabelConfig struct { metav1.ObjectMeta `json:"metadata,omitempty"` // spec describes the desired state of this AlertRelabelConfig object. - // +kubebuilder:validation:Required + // +required Spec AlertRelabelConfigSpec `json:"spec"` // status describes the current state of this AlertRelabelConfig object. @@ -254,7 +254,7 @@ type AlertRelabelConfigSpec struct { // configs is a list of sequentially evaluated alert relabel configs. // // +kubebuilder:validation:MinItems:=1 - // +kubebuilder:validation:Required + // +required Configs []RelabelConfig `json:"configs"` } @@ -286,7 +286,7 @@ type AlertRelabelConfigList struct { // items is a list of AlertRelabelConfigs. // +kubebuilder:validation:MinItems:=1 - // +kubebuilder:validation:Required + // +required Items []*AlertRelabelConfig `json:"items"` } diff --git a/network/v1/generated.proto b/network/v1/generated.proto index a429f04c026..4fc68a97402 100644 --- a/network/v1/generated.proto +++ b/network/v1/generated.proto @@ -29,39 +29,37 @@ message ClusterNetwork { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata optional .k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1; - // Network is a CIDR string specifying the global overlay network's L3 space + // network is a CIDR string specifying the global overlay network's L3 space // +kubebuilder:validation:Pattern=`^(([0-9]|[0-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[0-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])/([0-9]|[12][0-9]|3[0-2])$` optional string network = 2; - // 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 + // 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 // +kubebuilder:validation:Minimum=2 // +kubebuilder:validation:Maximum=30 optional uint32 hostsubnetlength = 3; - // ServiceNetwork is the CIDR range that Service IP addresses are allocated from + // serviceNetwork is the CIDR range that Service IP addresses are allocated from // +kubebuilder:validation:Pattern=`^(([0-9]|[0-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[0-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])/([0-9]|[12][0-9]|3[0-2])$` optional string serviceNetwork = 4; - // PluginName is the name of the network plugin being used + // pluginName is the name of the network plugin being used optional string pluginName = 5; - // 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. + // 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. repeated ClusterNetworkEntry clusterNetworks = 6; - // VXLANPort sets the VXLAN destination port used by the cluster. + // 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. // +kubebuilder:validation:Minimum=1 // +kubebuilder:validation:Maximum=65535 - // +kubebuilder:validation:Optional // +optional optional uint32 vxlanPort = 7; - // 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. + // 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. // +kubebuilder:validation:Minimum=576 // +kubebuilder:validation:Maximum=65536 - // +kubebuilder:validation:Optional // +optional optional uint32 mtu = 8; } @@ -72,7 +70,7 @@ message ClusterNetworkEntry { // +kubebuilder:validation:Pattern=`^(([0-9]|[0-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[0-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])/([0-9]|[12][0-9]|3[0-2])$` optional string cidr = 1; - // 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. + // 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. // +kubebuilder:validation:Minimum=2 // +kubebuilder:validation:Maximum=30 optional uint32 hostSubnetLength = 2; @@ -87,7 +85,7 @@ message ClusterNetworkList { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata optional .k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1; - // Items is the list of cluster networks + // items is the list of cluster networks repeated ClusterNetwork items = 2; } @@ -125,14 +123,14 @@ message EgressNetworkPolicyList { // EgressNetworkPolicyPeer specifies a target to apply egress network policy to message EgressNetworkPolicyPeer { - // CIDRSelector is the CIDR range to allow/deny traffic to. If this is set, dnsName must be unset + // 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. // +kubebuilder:validation:Pattern=`^(([0-9]|[0-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[0-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])/([0-9]|[12][0-9]|3[0-2])$` optional string cidrSelector = 1; - // DNSName is the domain name to allow/deny traffic to. If this is set, cidrSelector must be unset + // dnsName is the domain name to allow/deny traffic to. If this is set, cidrSelector must be unset // +kubebuilder:validation:Pattern=`^([A-Za-z0-9-]+\.)*[A-Za-z0-9-]+\.?$` optional string dnsName = 2; } @@ -172,25 +170,25 @@ message HostSubnet { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata optional .k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1; - // Host is the name of the node. (This is the same as the object's name, but both fields must be set.) + // host is the name of the node. (This is the same as the object's name, but both fields must be set.) // +kubebuilder:validation:Pattern=`^[a-z0-9.-]+$` optional string host = 2; - // HostIP is the IP address to be used as a VTEP by other nodes in the overlay network + // hostIP is the IP address to be used as a VTEP by other nodes in the overlay network // +kubebuilder:validation:Pattern=`^(([0-9]|[0-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[0-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$` optional string hostIP = 3; - // Subnet is the CIDR range of the overlay network assigned to the node for its pods + // subnet is the CIDR range of the overlay network assigned to the node for its pods // +kubebuilder:validation:Pattern=`^(([0-9]|[0-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[0-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])/([0-9]|[12][0-9]|3[0-2])$` optional string subnet = 4; - // EgressIPs is the list of automatic egress IP addresses currently hosted by this node. + // 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. // +optional repeated string egressIPs = 5; - // EgressCIDRs is the list of CIDR ranges available for automatically assigning + // 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. // +optional @@ -206,7 +204,7 @@ message HostSubnetList { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata optional .k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1; - // Items is the list of host subnets + // items is the list of host subnets repeated HostSubnet items = 2; } @@ -227,16 +225,16 @@ message NetNamespace { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata optional .k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1; - // NetName is the name of the network namespace. (This is the same as the object's name, but both fields must be set.) + // netname is the name of the network namespace. (This is the same as the object's name, but both fields must be set.) // +kubebuilder:validation:Pattern=`^[a-z0-9.-]+$` optional string netname = 2; - // 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. + // 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. // +kubebuilder:validation:Minimum=0 // +kubebuilder:validation:Maximum=16777215 optional uint32 netid = 3; - // EgressIPs is a list of reserved IPs that will be used as the source for external traffic coming from pods in this namespace. + // 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.) // +optional repeated string egressIPs = 4; @@ -251,7 +249,7 @@ message NetNamespaceList { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata optional .k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1; - // Items is the list of net namespaces + // items is the list of net namespaces repeated NetNamespace items = 2; } diff --git a/network/v1/types.go b/network/v1/types.go index 89015cf6b1b..7790802138c 100644 --- a/network/v1/types.go +++ b/network/v1/types.go @@ -32,39 +32,37 @@ type ClusterNetwork struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` - // Network is a CIDR string specifying the global overlay network's L3 space + // network is a CIDR string specifying the global overlay network's L3 space // +kubebuilder:validation:Pattern=`^(([0-9]|[0-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[0-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])/([0-9]|[12][0-9]|3[0-2])$` Network string `json:"network,omitempty" protobuf:"bytes,2,opt,name=network"` - // 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 + // 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 // +kubebuilder:validation:Minimum=2 // +kubebuilder:validation:Maximum=30 HostSubnetLength uint32 `json:"hostsubnetlength,omitempty" protobuf:"varint,3,opt,name=hostsubnetlength"` - // ServiceNetwork is the CIDR range that Service IP addresses are allocated from + // serviceNetwork is the CIDR range that Service IP addresses are allocated from // +kubebuilder:validation:Pattern=`^(([0-9]|[0-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[0-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])/([0-9]|[12][0-9]|3[0-2])$` ServiceNetwork string `json:"serviceNetwork" protobuf:"bytes,4,opt,name=serviceNetwork"` - // PluginName is the name of the network plugin being used + // pluginName is the name of the network plugin being used PluginName string `json:"pluginName,omitempty" protobuf:"bytes,5,opt,name=pluginName"` - // 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. + // 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. ClusterNetworks []ClusterNetworkEntry `json:"clusterNetworks" protobuf:"bytes,6,rep,name=clusterNetworks"` - // VXLANPort sets the VXLAN destination port used by the cluster. + // 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. // +kubebuilder:validation:Minimum=1 // +kubebuilder:validation:Maximum=65535 - // +kubebuilder:validation:Optional // +optional VXLANPort *uint32 `json:"vxlanPort,omitempty" protobuf:"varint,7,opt,name=vxlanPort"` - // 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. + // 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. // +kubebuilder:validation:Minimum=576 // +kubebuilder:validation:Maximum=65536 - // +kubebuilder:validation:Optional // +optional MTU *uint32 `json:"mtu,omitempty" protobuf:"varint,8,opt,name=mtu"` } @@ -75,7 +73,7 @@ type ClusterNetworkEntry struct { // +kubebuilder:validation:Pattern=`^(([0-9]|[0-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[0-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])/([0-9]|[12][0-9]|3[0-2])$` CIDR string `json:"CIDR" protobuf:"bytes,1,opt,name=cidr"` - // 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. + // 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. // +kubebuilder:validation:Minimum=2 // +kubebuilder:validation:Maximum=30 HostSubnetLength uint32 `json:"hostSubnetLength" protobuf:"varint,2,opt,name=hostSubnetLength"` @@ -94,7 +92,7 @@ type ClusterNetworkList struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` - // Items is the list of cluster networks + // items is the list of cluster networks Items []ClusterNetwork `json:"items" protobuf:"bytes,2,rep,name=items"` } @@ -134,25 +132,25 @@ type HostSubnet struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` - // Host is the name of the node. (This is the same as the object's name, but both fields must be set.) + // host is the name of the node. (This is the same as the object's name, but both fields must be set.) // +kubebuilder:validation:Pattern=`^[a-z0-9.-]+$` Host string `json:"host" protobuf:"bytes,2,opt,name=host"` - // HostIP is the IP address to be used as a VTEP by other nodes in the overlay network + // hostIP is the IP address to be used as a VTEP by other nodes in the overlay network // +kubebuilder:validation:Pattern=`^(([0-9]|[0-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[0-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$` HostIP string `json:"hostIP" protobuf:"bytes,3,opt,name=hostIP"` - // Subnet is the CIDR range of the overlay network assigned to the node for its pods + // subnet is the CIDR range of the overlay network assigned to the node for its pods // +kubebuilder:validation:Pattern=`^(([0-9]|[0-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[0-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])/([0-9]|[12][0-9]|3[0-2])$` Subnet string `json:"subnet" protobuf:"bytes,4,opt,name=subnet"` - // EgressIPs is the list of automatic egress IP addresses currently hosted by this node. + // 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. // +optional EgressIPs []HostSubnetEgressIP `json:"egressIPs,omitempty" protobuf:"bytes,5,rep,name=egressIPs"` - // EgressCIDRs is the list of CIDR ranges available for automatically assigning + // 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. // +optional @@ -172,7 +170,7 @@ type HostSubnetList struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` - // Items is the list of host subnets + // items is the list of host subnets Items []HostSubnet `json:"items" protobuf:"bytes,2,rep,name=items"` } @@ -204,16 +202,16 @@ type NetNamespace struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` - // NetName is the name of the network namespace. (This is the same as the object's name, but both fields must be set.) + // netname is the name of the network namespace. (This is the same as the object's name, but both fields must be set.) // +kubebuilder:validation:Pattern=`^[a-z0-9.-]+$` NetName string `json:"netname" protobuf:"bytes,2,opt,name=netname"` - // 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. + // 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. // +kubebuilder:validation:Minimum=0 // +kubebuilder:validation:Maximum=16777215 NetID uint32 `json:"netid" protobuf:"varint,3,opt,name=netid"` - // EgressIPs is a list of reserved IPs that will be used as the source for external traffic coming from pods in this namespace. + // 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.) // +optional EgressIPs []NetNamespaceEgressIP `json:"egressIPs,omitempty" protobuf:"bytes,4,rep,name=egressIPs"` @@ -232,7 +230,7 @@ type NetNamespaceList struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` - // Items is the list of net namespaces + // items is the list of net namespaces Items []NetNamespace `json:"items" protobuf:"bytes,2,rep,name=items"` } @@ -247,13 +245,13 @@ const ( // EgressNetworkPolicyPeer specifies a target to apply egress network policy to type EgressNetworkPolicyPeer struct { - // CIDRSelector is the CIDR range to allow/deny traffic to. If this is set, dnsName must be unset + // 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. // +kubebuilder:validation:Pattern=`^(([0-9]|[0-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[0-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])/([0-9]|[12][0-9]|3[0-2])$` CIDRSelector string `json:"cidrSelector,omitempty" protobuf:"bytes,1,rep,name=cidrSelector"` - // DNSName is the domain name to allow/deny traffic to. If this is set, cidrSelector must be unset + // dnsName is the domain name to allow/deny traffic to. If this is set, cidrSelector must be unset // +kubebuilder:validation:Pattern=`^([A-Za-z0-9-]+\.)*[A-Za-z0-9-]+\.?$` DNSName string `json:"dnsName,omitempty" protobuf:"bytes,2,rep,name=dnsName"` } diff --git a/network/v1/zz_generated.crd-manifests/001_clusternetworks.crd.yaml b/network/v1/zz_generated.crd-manifests/001_clusternetworks.crd.yaml index 93e86d2455f..5d0d5760a1d 100644 --- a/network/v1/zz_generated.crd-manifests/001_clusternetworks.crd.yaml +++ b/network/v1/zz_generated.crd-manifests/001_clusternetworks.crd.yaml @@ -47,7 +47,7 @@ spec: 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 + 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. items: @@ -62,7 +62,7 @@ spec: pattern: ^(([0-9]|[0-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[0-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])/([0-9]|[12][0-9]|3[0-2])$ type: string hostSubnetLength: - description: HostSubnetLength is the number of bits of the accompanying + 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. format: int32 @@ -75,7 +75,7 @@ spec: type: object type: array hostsubnetlength: - description: HostSubnetLength is the number of bits of network to allocate + 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 format: int32 @@ -93,7 +93,7 @@ spec: metadata: type: object mtu: - description: MTU is the MTU for the overlay network. This should be 50 + 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. format: int32 @@ -101,21 +101,21 @@ spec: minimum: 576 type: integer network: - description: Network is a CIDR string specifying the global overlay network's + description: network is a CIDR string specifying the global overlay network's L3 space pattern: ^(([0-9]|[0-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[0-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])/([0-9]|[12][0-9]|3[0-2])$ type: string pluginName: - description: PluginName is the name of the network plugin being used + description: pluginName is the name of the network plugin being used type: string serviceNetwork: - description: ServiceNetwork is the CIDR range that Service IP addresses + description: serviceNetwork is the CIDR range that Service IP addresses are allocated from pattern: ^(([0-9]|[0-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[0-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])/([0-9]|[12][0-9]|3[0-2])$ type: string vxlanPort: description: |- - VXLANPort sets the VXLAN destination port used by the cluster. + 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. diff --git a/network/v1/zz_generated.crd-manifests/002_hostsubnets.crd.yaml b/network/v1/zz_generated.crd-manifests/002_hostsubnets.crd.yaml index 1d79200bd5e..e8a9c2cc672 100644 --- a/network/v1/zz_generated.crd-manifests/002_hostsubnets.crd.yaml +++ b/network/v1/zz_generated.crd-manifests/002_hostsubnets.crd.yaml @@ -58,7 +58,7 @@ spec: type: string egressCIDRs: description: |- - EgressCIDRs is the list of CIDR ranges available for automatically assigning + 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. items: @@ -70,7 +70,7 @@ spec: type: array egressIPs: description: |- - EgressIPs is the list of automatic egress IP addresses currently hosted by this node. + 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. items: @@ -81,12 +81,12 @@ spec: type: string type: array host: - description: Host is the name of the node. (This is the same as the object's + description: host is the name of the node. (This is the same as the object's name, but both fields must be set.) pattern: ^[a-z0-9.-]+$ type: string hostIP: - description: HostIP is the IP address to be used as a VTEP by other nodes + description: hostIP is the IP address to be used as a VTEP by other nodes in the overlay network pattern: ^(([0-9]|[0-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[0-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$ type: string @@ -101,7 +101,7 @@ spec: metadata: type: object subnet: - description: Subnet is the CIDR range of the overlay network assigned + description: subnet is the CIDR range of the overlay network assigned to the node for its pods pattern: ^(([0-9]|[0-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[0-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])/([0-9]|[12][0-9]|3[0-2])$ type: string diff --git a/network/v1/zz_generated.crd-manifests/003_netnamespaces.crd.yaml b/network/v1/zz_generated.crd-manifests/003_netnamespaces.crd.yaml index 72b4f8d6229..9c2bc91abd5 100644 --- a/network/v1/zz_generated.crd-manifests/003_netnamespaces.crd.yaml +++ b/network/v1/zz_generated.crd-manifests/003_netnamespaces.crd.yaml @@ -44,7 +44,7 @@ spec: 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. + 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.) items: description: |- @@ -64,7 +64,7 @@ spec: metadata: type: object netid: - description: NetID is the network identifier of the network namespace + 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. format: int32 @@ -72,7 +72,7 @@ spec: minimum: 0 type: integer netname: - description: NetName is the name of the network namespace. (This is the + description: netname is the name of the network namespace. (This is the same as the object's name, but both fields must be set.) pattern: ^[a-z0-9.-]+$ type: string diff --git a/network/v1/zz_generated.featuregated-crd-manifests/clusternetworks.network.openshift.io/AAA_ungated.yaml b/network/v1/zz_generated.featuregated-crd-manifests/clusternetworks.network.openshift.io/AAA_ungated.yaml index 1e29f6dfe2f..83de10d6c6f 100644 --- a/network/v1/zz_generated.featuregated-crd-manifests/clusternetworks.network.openshift.io/AAA_ungated.yaml +++ b/network/v1/zz_generated.featuregated-crd-manifests/clusternetworks.network.openshift.io/AAA_ungated.yaml @@ -46,7 +46,7 @@ spec: 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 + 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. items: @@ -61,7 +61,7 @@ spec: pattern: ^(([0-9]|[0-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[0-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])/([0-9]|[12][0-9]|3[0-2])$ type: string hostSubnetLength: - description: HostSubnetLength is the number of bits of the accompanying + 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. format: int32 @@ -74,7 +74,7 @@ spec: type: object type: array hostsubnetlength: - description: HostSubnetLength is the number of bits of network to allocate + 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 format: int32 @@ -92,7 +92,7 @@ spec: metadata: type: object mtu: - description: MTU is the MTU for the overlay network. This should be 50 + 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. format: int32 @@ -100,21 +100,21 @@ spec: minimum: 576 type: integer network: - description: Network is a CIDR string specifying the global overlay network's + description: network is a CIDR string specifying the global overlay network's L3 space pattern: ^(([0-9]|[0-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[0-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])/([0-9]|[12][0-9]|3[0-2])$ type: string pluginName: - description: PluginName is the name of the network plugin being used + description: pluginName is the name of the network plugin being used type: string serviceNetwork: - description: ServiceNetwork is the CIDR range that Service IP addresses + description: serviceNetwork is the CIDR range that Service IP addresses are allocated from pattern: ^(([0-9]|[0-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[0-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])/([0-9]|[12][0-9]|3[0-2])$ type: string vxlanPort: description: |- - VXLANPort sets the VXLAN destination port used by the cluster. + 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. diff --git a/network/v1/zz_generated.featuregated-crd-manifests/hostsubnets.network.openshift.io/AAA_ungated.yaml b/network/v1/zz_generated.featuregated-crd-manifests/hostsubnets.network.openshift.io/AAA_ungated.yaml index 9aee94de6fb..36eb4106679 100644 --- a/network/v1/zz_generated.featuregated-crd-manifests/hostsubnets.network.openshift.io/AAA_ungated.yaml +++ b/network/v1/zz_generated.featuregated-crd-manifests/hostsubnets.network.openshift.io/AAA_ungated.yaml @@ -57,7 +57,7 @@ spec: type: string egressCIDRs: description: |- - EgressCIDRs is the list of CIDR ranges available for automatically assigning + 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. items: @@ -69,7 +69,7 @@ spec: type: array egressIPs: description: |- - EgressIPs is the list of automatic egress IP addresses currently hosted by this node. + 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. items: @@ -80,12 +80,12 @@ spec: type: string type: array host: - description: Host is the name of the node. (This is the same as the object's + description: host is the name of the node. (This is the same as the object's name, but both fields must be set.) pattern: ^[a-z0-9.-]+$ type: string hostIP: - description: HostIP is the IP address to be used as a VTEP by other nodes + description: hostIP is the IP address to be used as a VTEP by other nodes in the overlay network pattern: ^(([0-9]|[0-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[0-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$ type: string @@ -100,7 +100,7 @@ spec: metadata: type: object subnet: - description: Subnet is the CIDR range of the overlay network assigned + description: subnet is the CIDR range of the overlay network assigned to the node for its pods pattern: ^(([0-9]|[0-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[0-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])/([0-9]|[12][0-9]|3[0-2])$ type: string diff --git a/network/v1/zz_generated.featuregated-crd-manifests/netnamespaces.network.openshift.io/AAA_ungated.yaml b/network/v1/zz_generated.featuregated-crd-manifests/netnamespaces.network.openshift.io/AAA_ungated.yaml index d513252256e..c75f5b4a2ed 100644 --- a/network/v1/zz_generated.featuregated-crd-manifests/netnamespaces.network.openshift.io/AAA_ungated.yaml +++ b/network/v1/zz_generated.featuregated-crd-manifests/netnamespaces.network.openshift.io/AAA_ungated.yaml @@ -43,7 +43,7 @@ spec: 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. + 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.) items: description: |- @@ -63,7 +63,7 @@ spec: metadata: type: object netid: - description: NetID is the network identifier of the network namespace + 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. format: int32 @@ -71,7 +71,7 @@ spec: minimum: 0 type: integer netname: - description: NetName is the name of the network namespace. (This is the + description: netname is the name of the network namespace. (This is the same as the object's name, but both fields must be set.) pattern: ^[a-z0-9.-]+$ type: string diff --git a/network/v1/zz_generated.swagger_doc_generated.go b/network/v1/zz_generated.swagger_doc_generated.go index 743ddeab572..a0e1240962a 100644 --- a/network/v1/zz_generated.swagger_doc_generated.go +++ b/network/v1/zz_generated.swagger_doc_generated.go @@ -14,13 +14,13 @@ package v1 var map_ClusterNetwork = map[string]string{ "": "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).", "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "network": "Network is a CIDR string specifying the global overlay network's L3 space", - "hostsubnetlength": "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", - "serviceNetwork": "ServiceNetwork is the CIDR range that Service IP addresses are allocated from", - "pluginName": "PluginName is the name of the network plugin being used", - "clusterNetworks": "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.", - "vxlanPort": "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.", - "mtu": "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.", + "network": "network is a CIDR string specifying the global overlay network's L3 space", + "hostsubnetlength": "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", + "serviceNetwork": "serviceNetwork is the CIDR range that Service IP addresses are allocated from", + "pluginName": "pluginName is the name of the network plugin being used", + "clusterNetworks": "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.", + "vxlanPort": "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.", + "mtu": "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.", } func (ClusterNetwork) SwaggerDoc() map[string]string { @@ -30,7 +30,7 @@ func (ClusterNetwork) SwaggerDoc() map[string]string { var map_ClusterNetworkEntry = map[string]string{ "": "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.", "CIDR": "CIDR defines the total range of a cluster networks address space.", - "hostSubnetLength": "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.", + "hostSubnetLength": "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.", } func (ClusterNetworkEntry) SwaggerDoc() map[string]string { @@ -40,7 +40,7 @@ func (ClusterNetworkEntry) SwaggerDoc() map[string]string { var map_ClusterNetworkList = map[string]string{ "": "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).", "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "items": "Items is the list of cluster networks", + "items": "items is the list of cluster networks", } func (ClusterNetworkList) SwaggerDoc() map[string]string { @@ -69,8 +69,8 @@ func (EgressNetworkPolicyList) SwaggerDoc() map[string]string { var map_EgressNetworkPolicyPeer = map[string]string{ "": "EgressNetworkPolicyPeer specifies a target to apply egress network policy to", - "cidrSelector": "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.", - "dnsName": "DNSName is the domain name to allow/deny traffic to. If this is set, cidrSelector must be unset", + "cidrSelector": "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.", + "dnsName": "dnsName is the domain name to allow/deny traffic to. If this is set, cidrSelector must be unset", } func (EgressNetworkPolicyPeer) SwaggerDoc() map[string]string { @@ -99,11 +99,11 @@ func (EgressNetworkPolicySpec) SwaggerDoc() map[string]string { var map_HostSubnet = map[string]string{ "": "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).", "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "host": "Host is the name of the node. (This is the same as the object's name, but both fields must be set.)", - "hostIP": "HostIP is the IP address to be used as a VTEP by other nodes in the overlay network", - "subnet": "Subnet is the CIDR range of the overlay network assigned to the node for its pods", - "egressIPs": "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.", - "egressCIDRs": "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.", + "host": "host is the name of the node. (This is the same as the object's name, but both fields must be set.)", + "hostIP": "hostIP is the IP address to be used as a VTEP by other nodes in the overlay network", + "subnet": "subnet is the CIDR range of the overlay network assigned to the node for its pods", + "egressIPs": "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.", + "egressCIDRs": "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.", } func (HostSubnet) SwaggerDoc() map[string]string { @@ -113,7 +113,7 @@ func (HostSubnet) SwaggerDoc() map[string]string { var map_HostSubnetList = map[string]string{ "": "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).", "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "items": "Items is the list of host subnets", + "items": "items is the list of host subnets", } func (HostSubnetList) SwaggerDoc() map[string]string { @@ -123,9 +123,9 @@ func (HostSubnetList) SwaggerDoc() map[string]string { var map_NetNamespace = map[string]string{ "": "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).", "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "netname": "NetName is the name of the network namespace. (This is the same as the object's name, but both fields must be set.)", - "netid": "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.", - "egressIPs": "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.)", + "netname": "netname is the name of the network namespace. (This is the same as the object's name, but both fields must be set.)", + "netid": "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.", + "egressIPs": "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.)", } func (NetNamespace) SwaggerDoc() map[string]string { @@ -135,7 +135,7 @@ func (NetNamespace) SwaggerDoc() map[string]string { var map_NetNamespaceList = map[string]string{ "": "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).", "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "items": "Items is the list of net namespaces", + "items": "items is the list of net namespaces", } func (NetNamespaceList) SwaggerDoc() map[string]string { diff --git a/network/v1alpha1/types_dnsnameresolver.go b/network/v1alpha1/types_dnsnameresolver.go index 394f2e4ac07..cd0d1b31a5f 100644 --- a/network/v1alpha1/types_dnsnameresolver.go +++ b/network/v1alpha1/types_dnsnameresolver.go @@ -26,7 +26,7 @@ type DNSNameResolver struct { metav1.ObjectMeta `json:"metadata,omitempty"` // spec is the specification of the desired behavior of the DNSNameResolver. - // +kubebuilder:validation:Required + // +required Spec DNSNameResolverSpec `json:"spec"` // status is the most recently observed status of the DNSNameResolver. // +optional @@ -47,7 +47,7 @@ type DNSNameResolverSpec struct { // 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.' - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:XValidation:rule="self == oldSelf",message="spec.name is immutable" Name DNSName `json:"name"` } @@ -82,12 +82,12 @@ type DNSNameResolverResolvedName struct { // 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. - // +kubebuilder:validation:Required + // +required DNSName DNSName `json:"dnsName"` // resolvedAddresses gives the list of associated IP addresses and their corresponding TTLs and last // lookup times for the dnsName. - // +kubebuilder:validation:Required + // +required // +listType=map // +listMapKey=ip ResolvedAddresses []DNSNameResolverResolvedAddress `json:"resolvedAddresses"` @@ -106,21 +106,21 @@ type DNSNameResolverResolvedAddress struct { // 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. - // +kubebuilder:validation:Required + // +required IP string `json:"ip"` // 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. - // +kubebuilder:validation:Required + // +required TTLSeconds int32 `json:"ttlSeconds"` // 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. - // +kubebuilder:validation:Required + // +required LastLookupTime *metav1.Time `json:"lastLookupTime"` } diff --git a/networkoperator/v1/generated.proto b/networkoperator/v1/generated.proto index 37c374557d8..ebf09e7e9af 100644 --- a/networkoperator/v1/generated.proto +++ b/networkoperator/v1/generated.proto @@ -43,7 +43,7 @@ message EgressRouter { optional .k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1; // Specification of the desired egress router. - // +kubebuilder:validation:Required + // +required optional EgressRouterSpec spec = 2; // Observed status of EgressRouter. @@ -53,8 +53,8 @@ message EgressRouter { // EgressRouterAddress contains a pair of IP CIDR and gateway to be configured on the router's interface // +kubebuilder:validation:Required message EgressRouterAddress { - // IP is the address to configure on the router's interface. Can be IPv4 or IPv6. - // +kubebuilder:validation:Required + // ip is the address to configure on the router's interface. Can be IPv4 or IPv6. + // +required optional string ip = 1; // IP address of the next-hop gateway, if it cannot be automatically determined. Can be IPv4 or IPv6. @@ -86,30 +86,30 @@ message EgressRouterList { // +k8s:openapi-gen=true // +kubebuilder:validation:Required message EgressRouterSpec { - // Mode depicts the mode that is used for the egress router. The default mode is "Redirect" and is the only supported mode currently. - // +kubebuilder:validation:Required + // mode depicts the mode that is used for the egress router. The default mode is "Redirect" and is the only supported mode currently. + // +required // +kubebuilder:validation:Enum="Redirect" // +kubebuilder:default:="Redirect" optional string mode = 1; - // Redirect represents the configuration parameters specific to redirect mode. + // redirect represents the configuration parameters specific to redirect mode. optional RedirectConfig redirect = 2; // Specification of interface to create/use. The default is macvlan. // Currently only macvlan is supported. - // +kubebuilder:validation:Required + // +required // +kubebuilder:default:={macvlan: {mode: Bridge}} optional EgressRouterInterface networkInterface = 3; // List of IP addresses to configure on the pod's secondary interface. - // +kubebuilder:validation:Required + // +required repeated EgressRouterAddress addresses = 4; } // EgressRouterStatus contains the observed status of EgressRouter. Read-only. message EgressRouterStatus { // Observed status of the egress router - // +kubebuilder:validation:Required + // +required repeated EgressRouterStatusCondition conditions = 1; } @@ -117,28 +117,25 @@ message EgressRouterStatus { // managed and monitored components. // +k8s:deepcopy-gen=true message EgressRouterStatusCondition { - // Type specifies the aspect reported by this condition; one of Available, Progressing, Degraded - // +kubebuilder:validation:Required + // type specifies the aspect reported by this condition; one of Available, Progressing, Degraded // +kubebuilder:validation:Enum="Available";"Progressing";"Degraded" // +required optional string type = 1; - // Status of the condition, one of True, False, Unknown. - // +kubebuilder:validation:Required + // status of the condition, one of True, False, Unknown. // +kubebuilder:validation:Enum="True";"False";"Unknown" // +required optional string status = 2; - // LastTransitionTime is the time of the last update to the current status property. - // +kubebuilder:validation:Required + // lastTransitionTime is the time of the last update to the current status property. // +required // +nullable optional .k8s.io.apimachinery.pkg.apis.meta.v1.Time lastTransitionTime = 3; - // Reason is the CamelCase reason for the condition's current status. + // reason is the CamelCase reason for the condition's current status. optional string reason = 4; - // Message provides additional information about the current condition. + // 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. optional string message = 5; @@ -147,21 +144,21 @@ message EgressRouterStatusCondition { // L4RedirectRule defines a DNAT redirection from a given port to a destination IP and port. message L4RedirectRule { // IP specifies the remote destination's IP address. Can be IPv4 or IPv6. - // +kubebuilder:validation:Required + // +required optional string destinationIP = 1; - // Port is the port number to which clients should send traffic to be redirected. - // +kubebuilder:validation:Required + // port is the port number to which clients should send traffic to be redirected. + // +required // +kubebuilder:validation:Maximum:=65535 // +kubebuilder:validation:Minimum:=1 optional int32 port = 2; - // Protocol can be TCP, SCTP or UDP. - // +kubebuilder:validation:Required + // protocol can be TCP, SCTP or UDP. + // +required // +kubebuilder:validation:Enum="TCP";"UDP";"SCTP" optional string protocol = 3; - // TargetPort allows specifying the port number on the remote destination to which the traffic gets redirected to. + // targetPort allows specifying the port number on the remote destination to which the traffic gets redirected to. // If unspecified, the value from "Port" is used. // +kubebuilder:validation:Maximum:=65535 // +kubebuilder:validation:Minimum:=1 @@ -170,8 +167,8 @@ message L4RedirectRule { // MacvlanConfig consists of arguments specific to the macvlan EgressRouterInterfaceType message MacvlanConfig { - // Mode depicts the mode that is used for the macvlan interface; one of Bridge|Private|VEPA|Passthru. The default mode is "Bridge". - // +kubebuilder:validation:Required + // mode depicts the mode that is used for the macvlan interface; one of Bridge|Private|VEPA|Passthru. The default mode is "Bridge". + // +required // +kubebuilder:validation:Enum="Bridge";"Private";"VEPA";"Passthru" // +kubebuilder:default:="Bridge" optional string mode = 1; @@ -185,7 +182,7 @@ message RedirectConfig { // List of L4RedirectRules that define the DNAT redirection from the pod to the destination in redirect mode. repeated L4RedirectRule redirectRules = 1; - // FallbackIP specifies the remote destination's IP address. Can be IPv4 or IPv6. + // fallbackIP specifies the remote destination's IP address. Can be IPv4 or IPv6. // If no redirect rules are specified, all traffic from the router are redirected to this IP. // If redirect rules are specified, then any connections on any other port (undefined in the rules) on the router will be redirected to this IP. // If redirect rules are specified and no fallback IP is provided, connections on other ports will simply be rejected. diff --git a/networkoperator/v1/types_egressrouter.go b/networkoperator/v1/types_egressrouter.go index 9f11590e055..87e279eda8c 100644 --- a/networkoperator/v1/types_egressrouter.go +++ b/networkoperator/v1/types_egressrouter.go @@ -38,7 +38,7 @@ type EgressRouter struct { metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` // Specification of the desired egress router. - // +kubebuilder:validation:Required + // +required Spec EgressRouterSpec `json:"spec" protobuf:"bytes,2,opt,name=spec"` // Observed status of EgressRouter. @@ -51,23 +51,23 @@ type EgressRouter struct { // +k8s:openapi-gen=true // +kubebuilder:validation:Required type EgressRouterSpec struct { - // Mode depicts the mode that is used for the egress router. The default mode is "Redirect" and is the only supported mode currently. - // +kubebuilder:validation:Required + // mode depicts the mode that is used for the egress router. The default mode is "Redirect" and is the only supported mode currently. + // +required // +kubebuilder:validation:Enum="Redirect" // +kubebuilder:default:="Redirect" Mode EgressRouterMode `json:"mode" protobuf:"bytes,1,opt,name=mode,casttype=EgressRouterMode"` - // Redirect represents the configuration parameters specific to redirect mode. + // redirect represents the configuration parameters specific to redirect mode. Redirect *RedirectConfig `json:"redirect,omitempty" protobuf:"bytes,2,opt,name=redirect"` // Specification of interface to create/use. The default is macvlan. // Currently only macvlan is supported. - // +kubebuilder:validation:Required + // +required // +kubebuilder:default:={macvlan: {mode: Bridge}} NetworkInterface EgressRouterInterface `json:"networkInterface" protobuf:"bytes,3,opt,name=networkInterface"` // List of IP addresses to configure on the pod's secondary interface. - // +kubebuilder:validation:Required + // +required Addresses []EgressRouterAddress `json:"addresses" protobuf:"bytes,4,rep,name=addresses"` } @@ -86,7 +86,7 @@ type RedirectConfig struct { // List of L4RedirectRules that define the DNAT redirection from the pod to the destination in redirect mode. RedirectRules []L4RedirectRule `json:"redirectRules,omitempty" protobuf:"bytes,1,rep,name=redirectRules"` - // FallbackIP specifies the remote destination's IP address. Can be IPv4 or IPv6. + // fallbackIP specifies the remote destination's IP address. Can be IPv4 or IPv6. // If no redirect rules are specified, all traffic from the router are redirected to this IP. // If redirect rules are specified, then any connections on any other port (undefined in the rules) on the router will be redirected to this IP. // If redirect rules are specified and no fallback IP is provided, connections on other ports will simply be rejected. @@ -96,21 +96,21 @@ type RedirectConfig struct { // L4RedirectRule defines a DNAT redirection from a given port to a destination IP and port. type L4RedirectRule struct { // IP specifies the remote destination's IP address. Can be IPv4 or IPv6. - // +kubebuilder:validation:Required + // +required DestinationIP string `json:"destinationIP" protobuf:"bytes,1,opt,name=destinationIP"` - // Port is the port number to which clients should send traffic to be redirected. - // +kubebuilder:validation:Required + // port is the port number to which clients should send traffic to be redirected. + // +required // +kubebuilder:validation:Maximum:=65535 // +kubebuilder:validation:Minimum:=1 Port int32 `json:"port" protobuf:"varint,2,opt,name=port"` - // Protocol can be TCP, SCTP or UDP. - // +kubebuilder:validation:Required + // protocol can be TCP, SCTP or UDP. + // +required // +kubebuilder:validation:Enum="TCP";"UDP";"SCTP" Protocol ProtocolType `json:"protocol" protobuf:"bytes,3,opt,name=protocol,casttype=ProtocolType"` - // TargetPort allows specifying the port number on the remote destination to which the traffic gets redirected to. + // targetPort allows specifying the port number on the remote destination to which the traffic gets redirected to. // If unspecified, the value from "Port" is used. // +kubebuilder:validation:Maximum:=65535 // +kubebuilder:validation:Minimum:=1 @@ -165,8 +165,8 @@ const ( // MacvlanConfig consists of arguments specific to the macvlan EgressRouterInterfaceType type MacvlanConfig struct { - // Mode depicts the mode that is used for the macvlan interface; one of Bridge|Private|VEPA|Passthru. The default mode is "Bridge". - // +kubebuilder:validation:Required + // mode depicts the mode that is used for the macvlan interface; one of Bridge|Private|VEPA|Passthru. The default mode is "Bridge". + // +required // +kubebuilder:validation:Enum="Bridge";"Private";"VEPA";"Passthru" // +kubebuilder:default:="Bridge" Mode MacvlanMode `json:"mode" protobuf:"bytes,1,opt,name=mode,casttype=MacvlanMode"` @@ -178,8 +178,8 @@ type MacvlanConfig struct { // EgressRouterAddress contains a pair of IP CIDR and gateway to be configured on the router's interface // +kubebuilder:validation:Required type EgressRouterAddress struct { - // IP is the address to configure on the router's interface. Can be IPv4 or IPv6. - // +kubebuilder:validation:Required + // ip is the address to configure on the router's interface. Can be IPv4 or IPv6. + // +required IP string `json:"ip" protobuf:"bytes,1,opt,name=ip"` // IP address of the next-hop gateway, if it cannot be automatically determined. Can be IPv4 or IPv6. Gateway string `json:"gateway,omitempty" protobuf:"bytes,2,opt,name=gateway"` @@ -219,28 +219,25 @@ const ( // managed and monitored components. // +k8s:deepcopy-gen=true type EgressRouterStatusCondition struct { - // Type specifies the aspect reported by this condition; one of Available, Progressing, Degraded - // +kubebuilder:validation:Required + // type specifies the aspect reported by this condition; one of Available, Progressing, Degraded // +kubebuilder:validation:Enum="Available";"Progressing";"Degraded" // +required Type EgressRouterStatusConditionType `json:"type" protobuf:"bytes,1,opt,name=type,casttype=EgressRouterStatusConditionType"` - // Status of the condition, one of True, False, Unknown. - // +kubebuilder:validation:Required + // status of the condition, one of True, False, Unknown. // +kubebuilder:validation:Enum="True";"False";"Unknown" // +required Status ConditionStatus `json:"status" protobuf:"bytes,2,opt,name=status,casttype=ConditionStatus"` - // LastTransitionTime is the time of the last update to the current status property. - // +kubebuilder:validation:Required + // lastTransitionTime is the time of the last update to the current status property. // +required // +nullable LastTransitionTime metav1.Time `json:"lastTransitionTime" protobuf:"bytes,3,opt,name=lastTransitionTime"` - // Reason is the CamelCase reason for the condition's current status. + // reason is the CamelCase reason for the condition's current status. Reason string `json:"reason,omitempty" protobuf:"bytes,4,opt,name=reason"` - // Message provides additional information about the current condition. + // 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. Message string `json:"message,omitempty" protobuf:"bytes,5,opt,name=message"` @@ -249,7 +246,7 @@ type EgressRouterStatusCondition struct { // EgressRouterStatus contains the observed status of EgressRouter. Read-only. type EgressRouterStatus struct { // Observed status of the egress router - // +kubebuilder:validation:Required + // +required Conditions []EgressRouterStatusCondition `json:"conditions,omitempty" protobuf:"bytes,1,rep,name=conditions"` } diff --git a/networkoperator/v1/zz_generated.crd-manifests/001_egressrouters.crd.yaml b/networkoperator/v1/zz_generated.crd-manifests/001_egressrouters.crd.yaml index a3021a11875..2dff3e06704 100644 --- a/networkoperator/v1/zz_generated.crd-manifests/001_egressrouters.crd.yaml +++ b/networkoperator/v1/zz_generated.crd-manifests/001_egressrouters.crd.yaml @@ -84,7 +84,7 @@ spec: be automatically determined. Can be IPv4 or IPv6. type: string ip: - description: IP is the address to configure on the router's + description: ip is the address to configure on the router's interface. Can be IPv4 or IPv6. type: string required: @@ -93,7 +93,7 @@ spec: type: array mode: default: Redirect - description: Mode depicts the mode that is used for the egress router. + description: mode depicts the mode that is used for the egress router. The default mode is "Redirect" and is the only supported mode currently. enum: - Redirect @@ -120,7 +120,7 @@ spec: type: string mode: default: Bridge - description: Mode depicts the mode that is used for the macvlan + description: mode depicts the mode that is used for the macvlan interface; one of Bridge|Private|VEPA|Passthru. The default mode is "Bridge". enum: @@ -134,7 +134,7 @@ spec: type: object type: object redirect: - description: Redirect represents the configuration parameters specific + description: redirect represents the configuration parameters specific to redirect mode. properties: fallbackIP: @@ -142,7 +142,7 @@ spec: - format: ipv4 - format: ipv6 description: |- - FallbackIP specifies the remote destination's IP address. Can be IPv4 or IPv6. + fallbackIP specifies the remote destination's IP address. Can be IPv4 or IPv6. If no redirect rules are specified, all traffic from the router are redirected to this IP. If redirect rules are specified, then any connections on any other port (undefined in the rules) on the router will be redirected to this IP. If redirect rules are specified and no fallback IP is provided, connections on other ports will simply be rejected. @@ -162,14 +162,14 @@ spec: Can be IPv4 or IPv6. type: string port: - description: Port is the port number to which clients should + description: port is the port number to which clients should send traffic to be redirected. format: int32 maximum: 65535 minimum: 1 type: integer protocol: - description: Protocol can be TCP, SCTP or UDP. + description: protocol can be TCP, SCTP or UDP. enum: - TCP - UDP @@ -177,7 +177,7 @@ spec: type: string targetPort: description: |- - TargetPort allows specifying the port number on the remote destination to which the traffic gets redirected to. + targetPort allows specifying the port number on the remote destination to which the traffic gets redirected to. If unspecified, the value from "Port" is used. format: int32 maximum: 65535 @@ -206,30 +206,30 @@ spec: managed and monitored components. properties: lastTransitionTime: - description: LastTransitionTime is the time of the last update + description: lastTransitionTime is the time of the last update to the current status property. format: date-time nullable: true type: string message: description: |- - Message provides additional information about the current condition. + 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 + 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. + description: status of the condition, one of True, False, Unknown. enum: - "True" - "False" - Unknown type: string type: - description: Type specifies the aspect reported by this condition; + description: type specifies the aspect reported by this condition; one of Available, Progressing, Degraded enum: - Available diff --git a/networkoperator/v1/zz_generated.featuregated-crd-manifests/egressrouters.network.operator.openshift.io/AAA_ungated.yaml b/networkoperator/v1/zz_generated.featuregated-crd-manifests/egressrouters.network.operator.openshift.io/AAA_ungated.yaml index 8c4a3f6cb17..8e26586ea25 100644 --- a/networkoperator/v1/zz_generated.featuregated-crd-manifests/egressrouters.network.operator.openshift.io/AAA_ungated.yaml +++ b/networkoperator/v1/zz_generated.featuregated-crd-manifests/egressrouters.network.operator.openshift.io/AAA_ungated.yaml @@ -75,7 +75,7 @@ spec: be automatically determined. Can be IPv4 or IPv6. type: string ip: - description: IP is the address to configure on the router's + description: ip is the address to configure on the router's interface. Can be IPv4 or IPv6. type: string required: @@ -84,7 +84,7 @@ spec: type: array mode: default: Redirect - description: Mode depicts the mode that is used for the egress router. + description: mode depicts the mode that is used for the egress router. The default mode is "Redirect" and is the only supported mode currently. enum: - Redirect @@ -108,7 +108,7 @@ spec: type: string mode: default: Bridge - description: Mode depicts the mode that is used for the macvlan + description: mode depicts the mode that is used for the macvlan interface; one of Bridge|Private|VEPA|Passthru. The default mode is "Bridge". enum: @@ -122,12 +122,12 @@ spec: type: object type: object redirect: - description: Redirect represents the configuration parameters specific + description: redirect represents the configuration parameters specific to redirect mode. properties: fallbackIP: description: |- - FallbackIP specifies the remote destination's IP address. Can be IPv4 or IPv6. + fallbackIP specifies the remote destination's IP address. Can be IPv4 or IPv6. If no redirect rules are specified, all traffic from the router are redirected to this IP. If redirect rules are specified, then any connections on any other port (undefined in the rules) on the router will be redirected to this IP. If redirect rules are specified and no fallback IP is provided, connections on other ports will simply be rejected. @@ -144,14 +144,14 @@ spec: Can be IPv4 or IPv6. type: string port: - description: Port is the port number to which clients should + description: port is the port number to which clients should send traffic to be redirected. format: int32 maximum: 65535 minimum: 1 type: integer protocol: - description: Protocol can be TCP, SCTP or UDP. + description: protocol can be TCP, SCTP or UDP. enum: - TCP - UDP @@ -159,7 +159,7 @@ spec: type: string targetPort: description: |- - TargetPort allows specifying the port number on the remote destination to which the traffic gets redirected to. + targetPort allows specifying the port number on the remote destination to which the traffic gets redirected to. If unspecified, the value from "Port" is used. format: int32 maximum: 65535 @@ -188,30 +188,30 @@ spec: managed and monitored components. properties: lastTransitionTime: - description: LastTransitionTime is the time of the last update + description: lastTransitionTime is the time of the last update to the current status property. format: date-time nullable: true type: string message: description: |- - Message provides additional information about the current condition. + 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 + 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. + description: status of the condition, one of True, False, Unknown. enum: - "True" - "False" - Unknown type: string type: - description: Type specifies the aspect reported by this condition; + description: type specifies the aspect reported by this condition; one of Available, Progressing, Degraded enum: - Available diff --git a/networkoperator/v1/zz_generated.swagger_doc_generated.go b/networkoperator/v1/zz_generated.swagger_doc_generated.go index 97bec9e29d9..000cb190336 100644 --- a/networkoperator/v1/zz_generated.swagger_doc_generated.go +++ b/networkoperator/v1/zz_generated.swagger_doc_generated.go @@ -24,7 +24,7 @@ func (EgressRouter) SwaggerDoc() map[string]string { var map_EgressRouterAddress = map[string]string{ "": "EgressRouterAddress contains a pair of IP CIDR and gateway to be configured on the router's interface", - "ip": "IP is the address to configure on the router's interface. Can be IPv4 or IPv6.", + "ip": "ip is the address to configure on the router's interface. Can be IPv4 or IPv6.", "gateway": "IP address of the next-hop gateway, if it cannot be automatically determined. Can be IPv4 or IPv6.", } @@ -52,8 +52,8 @@ func (EgressRouterList) SwaggerDoc() map[string]string { var map_EgressRouterSpec = map[string]string{ "": "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.", - "mode": "Mode depicts the mode that is used for the egress router. The default mode is \"Redirect\" and is the only supported mode currently.", - "redirect": "Redirect represents the configuration parameters specific to redirect mode.", + "mode": "mode depicts the mode that is used for the egress router. The default mode is \"Redirect\" and is the only supported mode currently.", + "redirect": "redirect represents the configuration parameters specific to redirect mode.", "networkInterface": "Specification of interface to create/use. The default is macvlan. Currently only macvlan is supported.", "addresses": "List of IP addresses to configure on the pod's secondary interface.", } @@ -73,11 +73,11 @@ func (EgressRouterStatus) SwaggerDoc() map[string]string { var map_EgressRouterStatusCondition = map[string]string{ "": "EgressRouterStatusCondition represents the state of the egress router's managed and monitored components.", - "type": "Type specifies the aspect reported by this condition; one of Available, Progressing, Degraded", - "status": "Status of the condition, one of True, False, Unknown.", - "lastTransitionTime": "LastTransitionTime is the time of the last update to the current status property.", - "reason": "Reason is the CamelCase reason for the condition's current status.", - "message": "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": "type specifies the aspect reported by this condition; one of Available, Progressing, Degraded", + "status": "status of the condition, one of True, False, Unknown.", + "lastTransitionTime": "lastTransitionTime is the time of the last update to the current status property.", + "reason": "reason is the CamelCase reason for the condition's current status.", + "message": "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.", } func (EgressRouterStatusCondition) SwaggerDoc() map[string]string { @@ -87,9 +87,9 @@ func (EgressRouterStatusCondition) SwaggerDoc() map[string]string { var map_L4RedirectRule = map[string]string{ "": "L4RedirectRule defines a DNAT redirection from a given port to a destination IP and port.", "destinationIP": "IP specifies the remote destination's IP address. Can be IPv4 or IPv6.", - "port": "Port is the port number to which clients should send traffic to be redirected.", - "protocol": "Protocol can be TCP, SCTP or UDP.", - "targetPort": "TargetPort allows specifying the port number on the remote destination to which the traffic gets redirected to. If unspecified, the value from \"Port\" is used.", + "port": "port is the port number to which clients should send traffic to be redirected.", + "protocol": "protocol can be TCP, SCTP or UDP.", + "targetPort": "targetPort allows specifying the port number on the remote destination to which the traffic gets redirected to. If unspecified, the value from \"Port\" is used.", } func (L4RedirectRule) SwaggerDoc() map[string]string { @@ -98,7 +98,7 @@ func (L4RedirectRule) SwaggerDoc() map[string]string { var map_MacvlanConfig = map[string]string{ "": "MacvlanConfig consists of arguments specific to the macvlan EgressRouterInterfaceType", - "mode": "Mode depicts the mode that is used for the macvlan interface; one of Bridge|Private|VEPA|Passthru. The default mode is \"Bridge\".", + "mode": "mode depicts the mode that is used for the macvlan interface; one of Bridge|Private|VEPA|Passthru. The default mode is \"Bridge\".", "master": "Name of the master interface. Need not be specified if it can be inferred from the IP address.", } @@ -109,7 +109,7 @@ func (MacvlanConfig) SwaggerDoc() map[string]string { var map_RedirectConfig = map[string]string{ "": "RedirectConfig represents the configuration parameters specific to redirect mode.", "redirectRules": "List of L4RedirectRules that define the DNAT redirection from the pod to the destination in redirect mode.", - "fallbackIP": "FallbackIP specifies the remote destination's IP address. Can be IPv4 or IPv6. If no redirect rules are specified, all traffic from the router are redirected to this IP. If redirect rules are specified, then any connections on any other port (undefined in the rules) on the router will be redirected to this IP. If redirect rules are specified and no fallback IP is provided, connections on other ports will simply be rejected.", + "fallbackIP": "fallbackIP specifies the remote destination's IP address. Can be IPv4 or IPv6. If no redirect rules are specified, all traffic from the router are redirected to this IP. If redirect rules are specified, then any connections on any other port (undefined in the rules) on the router will be redirected to this IP. If redirect rules are specified and no fallback IP is provided, connections on other ports will simply be rejected.", } func (RedirectConfig) SwaggerDoc() map[string]string { diff --git a/oauth/v1/generated.proto b/oauth/v1/generated.proto index 7630d896da1..4a5474e0c64 100644 --- a/oauth/v1/generated.proto +++ b/oauth/v1/generated.proto @@ -13,13 +13,13 @@ option go_package = "github.com/openshift/api/oauth/v1"; // ClusterRoleScopeRestriction describes restrictions on cluster role scopes message ClusterRoleScopeRestriction { - // RoleNames is the list of cluster roles that can referenced. * means anything + // roleNames is the list of cluster roles that can referenced. * means anything repeated string roleNames = 1; - // Namespaces is the list of namespaces that can be referenced. * means any of them (including *) + // namespaces is the list of namespaces that can be referenced. * means any of them (including *) repeated string namespaces = 2; - // AllowEscalation indicates whether you can request roles and their escalating resources + // allowEscalation indicates whether you can request roles and their escalating resources optional bool allowEscalation = 3; } @@ -37,31 +37,31 @@ message OAuthAccessToken { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata optional .k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1; - // ClientName references the client that created this token. + // clientName references the client that created this token. optional string clientName = 2; - // ExpiresIn is the seconds from CreationTime before this token expires. + // expiresIn is the seconds from CreationTime before this token expires. optional int64 expiresIn = 3; - // Scopes is an array of the requested scopes. + // scopes is an array of the requested scopes. repeated string scopes = 4; - // RedirectURI is the redirection associated with the token. + // redirectURI is the redirection associated with the token. optional string redirectURI = 5; - // UserName is the user name associated with this token + // userName is the user name associated with this token optional string userName = 6; - // UserUID is the unique UID associated with this token + // userUID is the unique UID associated with this token optional string userUID = 7; - // AuthorizeToken contains the token that authorized this token + // authorizeToken contains the token that authorized this token optional string authorizeToken = 8; - // RefreshToken is the value by which this token can be renewed. Can be blank. + // refreshToken is the value by which this token can be renewed. Can be blank. optional string refreshToken = 9; - // InactivityTimeoutSeconds is the value in seconds, from the + // 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. optional int32 inactivityTimeoutSeconds = 10; @@ -76,7 +76,7 @@ message OAuthAccessTokenList { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata optional .k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1; - // Items is the list of OAuth access tokens + // items is the list of OAuth access tokens repeated OAuthAccessToken items = 2; } @@ -89,32 +89,32 @@ message OAuthAuthorizeToken { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata optional .k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1; - // ClientName references the client that created this token. + // clientName references the client that created this token. optional string clientName = 2; - // ExpiresIn is the seconds from CreationTime before this token expires. + // expiresIn is the seconds from CreationTime before this token expires. optional int64 expiresIn = 3; - // Scopes is an array of the requested scopes. + // scopes is an array of the requested scopes. repeated string scopes = 4; - // RedirectURI is the redirection associated with the token. + // redirectURI is the redirection associated with the token. optional string redirectURI = 5; - // State data from request + // state data from request optional string state = 6; - // UserName is the user name associated with this token + // userName is the user name associated with this token optional string userName = 7; - // UserUID is the unique UID associated with this token. UserUID and UserName must both match + // userUID is the unique UID associated with this token. UserUID and UserName must both match // for this token to be valid. optional string userUID = 8; - // CodeChallenge is the optional code_challenge associated with this authorization code, as described in rfc7636 + // codeChallenge is the optional code_challenge associated with this authorization code, as described in rfc7636 optional string codeChallenge = 9; - // CodeChallengeMethod is the optional code_challenge_method associated with this authorization code, as described in rfc7636 + // codeChallengeMethod is the optional code_challenge_method associated with this authorization code, as described in rfc7636 optional string codeChallengeMethod = 10; } @@ -127,7 +127,7 @@ message OAuthAuthorizeTokenList { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata optional .k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1; - // Items is the list of OAuth authorization tokens + // items is the list of OAuth authorization tokens repeated OAuthAuthorizeToken items = 2; } @@ -140,36 +140,36 @@ message OAuthClient { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata optional .k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1; - // Secret is the unique secret associated with a client + // secret is the unique secret associated with a client optional string secret = 2; - // AdditionalSecrets holds other secrets that may be used to identify the client. This is useful for rotation + // additionalSecrets holds other secrets that may be used to identify the client. This is useful for rotation // and for service account token validation repeated string additionalSecrets = 3; - // RespondWithChallenges indicates whether the client wants authentication needed responses made in the form of challenges instead of redirects + // respondWithChallenges indicates whether the client wants authentication needed responses made in the form of challenges instead of redirects optional bool respondWithChallenges = 4; - // RedirectURIs is the valid redirection URIs associated with a client + // redirectURIs is the valid redirection URIs associated with a client // +patchStrategy=merge repeated string redirectURIs = 5; - // GrantMethod is a required field which determines how to handle grants for this client. + // grantMethod is a required field which determines how to handle grants for this client. // Valid grant handling methods are: // - auto: always approves grant requests, useful for trusted clients // - prompt: prompts the end user for approval of grant requests, useful for third-party clients optional string grantMethod = 6; - // ScopeRestrictions describes which scopes this client can request. Each requested scope + // 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. repeated ScopeRestriction scopeRestrictions = 7; - // AccessTokenMaxAgeSeconds overrides the default access token max age for tokens granted to this client. + // accessTokenMaxAgeSeconds overrides the default access token max age for tokens granted to this client. // 0 means no expiration. optional int32 accessTokenMaxAgeSeconds = 8; - // AccessTokenInactivityTimeoutSeconds overrides the default token + // 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 @@ -194,17 +194,17 @@ message OAuthClientAuthorization { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata optional .k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1; - // ClientName references the client that created this authorization + // clientName references the client that created this authorization optional string clientName = 2; - // UserName is the user name that authorized this client + // userName is the user name that authorized this client optional string userName = 3; - // UserUID is the unique UID associated with this authorization. UserUID and UserName + // userUID is the unique UID associated with this authorization. UserUID and UserName // must both match for this authorization to be valid. optional string userUID = 4; - // Scopes is an array of the granted scopes. + // scopes is an array of the granted scopes. repeated string scopes = 5; } @@ -217,7 +217,7 @@ message OAuthClientAuthorizationList { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata optional .k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1; - // Items is the list of OAuth client authorizations + // items is the list of OAuth client authorizations repeated OAuthClientAuthorization items = 2; } @@ -230,7 +230,7 @@ message OAuthClientList { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata optional .k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1; - // Items is the list of OAuth clients + // items is the list of OAuth clients repeated OAuthClient items = 2; } @@ -264,7 +264,7 @@ message ScopeRestriction { // ExactValues means the scope has to match a particular set of strings exactly repeated string literals = 1; - // ClusterRole describes a set of restrictions for cluster role scoping. + // clusterRole describes a set of restrictions for cluster role scoping. optional ClusterRoleScopeRestriction clusterRole = 2; } @@ -276,31 +276,31 @@ message UserOAuthAccessToken { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata optional .k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1; - // ClientName references the client that created this token. + // clientName references the client that created this token. optional string clientName = 2; - // ExpiresIn is the seconds from CreationTime before this token expires. + // expiresIn is the seconds from CreationTime before this token expires. optional int64 expiresIn = 3; - // Scopes is an array of the requested scopes. + // scopes is an array of the requested scopes. repeated string scopes = 4; - // RedirectURI is the redirection associated with the token. + // redirectURI is the redirection associated with the token. optional string redirectURI = 5; - // UserName is the user name associated with this token + // userName is the user name associated with this token optional string userName = 6; - // UserUID is the unique UID associated with this token + // userUID is the unique UID associated with this token optional string userUID = 7; - // AuthorizeToken contains the token that authorized this token + // authorizeToken contains the token that authorized this token optional string authorizeToken = 8; - // RefreshToken is the value by which this token can be renewed. Can be blank. + // refreshToken is the value by which this token can be renewed. Can be blank. optional string refreshToken = 9; - // InactivityTimeoutSeconds is the value in seconds, from the + // 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. optional int32 inactivityTimeoutSeconds = 10; diff --git a/oauth/v1/types.go b/oauth/v1/types.go index 026c527f5b9..5a70b477494 100644 --- a/oauth/v1/types.go +++ b/oauth/v1/types.go @@ -24,31 +24,31 @@ type OAuthAccessToken struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` - // ClientName references the client that created this token. + // clientName references the client that created this token. ClientName string `json:"clientName,omitempty" protobuf:"bytes,2,opt,name=clientName"` - // ExpiresIn is the seconds from CreationTime before this token expires. + // expiresIn is the seconds from CreationTime before this token expires. ExpiresIn int64 `json:"expiresIn,omitempty" protobuf:"varint,3,opt,name=expiresIn"` - // Scopes is an array of the requested scopes. + // scopes is an array of the requested scopes. Scopes []string `json:"scopes,omitempty" protobuf:"bytes,4,rep,name=scopes"` - // RedirectURI is the redirection associated with the token. + // redirectURI is the redirection associated with the token. RedirectURI string `json:"redirectURI,omitempty" protobuf:"bytes,5,opt,name=redirectURI"` - // UserName is the user name associated with this token + // userName is the user name associated with this token UserName string `json:"userName,omitempty" protobuf:"bytes,6,opt,name=userName"` - // UserUID is the unique UID associated with this token + // userUID is the unique UID associated with this token UserUID string `json:"userUID,omitempty" protobuf:"bytes,7,opt,name=userUID"` - // AuthorizeToken contains the token that authorized this token + // authorizeToken contains the token that authorized this token AuthorizeToken string `json:"authorizeToken,omitempty" protobuf:"bytes,8,opt,name=authorizeToken"` - // RefreshToken is the value by which this token can be renewed. Can be blank. + // refreshToken is the value by which this token can be renewed. Can be blank. RefreshToken string `json:"refreshToken,omitempty" protobuf:"bytes,9,opt,name=refreshToken"` - // InactivityTimeoutSeconds is the value in seconds, from the + // 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. InactivityTimeoutSeconds int32 `json:"inactivityTimeoutSeconds,omitempty" protobuf:"varint,10,opt,name=inactivityTimeoutSeconds"` @@ -69,32 +69,32 @@ type OAuthAuthorizeToken struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` - // ClientName references the client that created this token. + // clientName references the client that created this token. ClientName string `json:"clientName,omitempty" protobuf:"bytes,2,opt,name=clientName"` - // ExpiresIn is the seconds from CreationTime before this token expires. + // expiresIn is the seconds from CreationTime before this token expires. ExpiresIn int64 `json:"expiresIn,omitempty" protobuf:"varint,3,opt,name=expiresIn"` - // Scopes is an array of the requested scopes. + // scopes is an array of the requested scopes. Scopes []string `json:"scopes,omitempty" protobuf:"bytes,4,rep,name=scopes"` - // RedirectURI is the redirection associated with the token. + // redirectURI is the redirection associated with the token. RedirectURI string `json:"redirectURI,omitempty" protobuf:"bytes,5,opt,name=redirectURI"` - // State data from request + // state data from request State string `json:"state,omitempty" protobuf:"bytes,6,opt,name=state"` - // UserName is the user name associated with this token + // userName is the user name associated with this token UserName string `json:"userName,omitempty" protobuf:"bytes,7,opt,name=userName"` - // UserUID is the unique UID associated with this token. UserUID and UserName must both match + // userUID is the unique UID associated with this token. UserUID and UserName must both match // for this token to be valid. UserUID string `json:"userUID,omitempty" protobuf:"bytes,8,opt,name=userUID"` - // CodeChallenge is the optional code_challenge associated with this authorization code, as described in rfc7636 + // codeChallenge is the optional code_challenge associated with this authorization code, as described in rfc7636 CodeChallenge string `json:"codeChallenge,omitempty" protobuf:"bytes,9,opt,name=codeChallenge"` - // CodeChallengeMethod is the optional code_challenge_method associated with this authorization code, as described in rfc7636 + // codeChallengeMethod is the optional code_challenge_method associated with this authorization code, as described in rfc7636 CodeChallengeMethod string `json:"codeChallengeMethod,omitempty" protobuf:"bytes,10,opt,name=codeChallengeMethod"` } @@ -113,36 +113,36 @@ type OAuthClient struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` - // Secret is the unique secret associated with a client + // secret is the unique secret associated with a client Secret string `json:"secret,omitempty" protobuf:"bytes,2,opt,name=secret"` - // AdditionalSecrets holds other secrets that may be used to identify the client. This is useful for rotation + // additionalSecrets holds other secrets that may be used to identify the client. This is useful for rotation // and for service account token validation AdditionalSecrets []string `json:"additionalSecrets,omitempty" protobuf:"bytes,3,rep,name=additionalSecrets"` - // RespondWithChallenges indicates whether the client wants authentication needed responses made in the form of challenges instead of redirects + // respondWithChallenges indicates whether the client wants authentication needed responses made in the form of challenges instead of redirects RespondWithChallenges bool `json:"respondWithChallenges,omitempty" protobuf:"varint,4,opt,name=respondWithChallenges"` - // RedirectURIs is the valid redirection URIs associated with a client + // redirectURIs is the valid redirection URIs associated with a client // +patchStrategy=merge RedirectURIs []string `json:"redirectURIs,omitempty" patchStrategy:"merge" protobuf:"bytes,5,rep,name=redirectURIs"` - // GrantMethod is a required field which determines how to handle grants for this client. + // grantMethod is a required field which determines how to handle grants for this client. // Valid grant handling methods are: // - auto: always approves grant requests, useful for trusted clients // - prompt: prompts the end user for approval of grant requests, useful for third-party clients GrantMethod GrantHandlerType `json:"grantMethod,omitempty" protobuf:"bytes,6,opt,name=grantMethod,casttype=GrantHandlerType"` - // ScopeRestrictions describes which scopes this client can request. Each requested scope + // 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. ScopeRestrictions []ScopeRestriction `json:"scopeRestrictions,omitempty" protobuf:"bytes,7,rep,name=scopeRestrictions"` - // AccessTokenMaxAgeSeconds overrides the default access token max age for tokens granted to this client. + // accessTokenMaxAgeSeconds overrides the default access token max age for tokens granted to this client. // 0 means no expiration. AccessTokenMaxAgeSeconds *int32 `json:"accessTokenMaxAgeSeconds,omitempty" protobuf:"varint,8,opt,name=accessTokenMaxAgeSeconds"` - // AccessTokenInactivityTimeoutSeconds overrides the default token + // 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 @@ -174,17 +174,17 @@ type ScopeRestriction struct { // ExactValues means the scope has to match a particular set of strings exactly ExactValues []string `json:"literals,omitempty" protobuf:"bytes,1,rep,name=literals"` - // ClusterRole describes a set of restrictions for cluster role scoping. + // clusterRole describes a set of restrictions for cluster role scoping. ClusterRole *ClusterRoleScopeRestriction `json:"clusterRole,omitempty" protobuf:"bytes,2,opt,name=clusterRole"` } // ClusterRoleScopeRestriction describes restrictions on cluster role scopes type ClusterRoleScopeRestriction struct { - // RoleNames is the list of cluster roles that can referenced. * means anything + // roleNames is the list of cluster roles that can referenced. * means anything RoleNames []string `json:"roleNames" protobuf:"bytes,1,rep,name=roleNames"` - // Namespaces is the list of namespaces that can be referenced. * means any of them (including *) + // namespaces is the list of namespaces that can be referenced. * means any of them (including *) Namespaces []string `json:"namespaces" protobuf:"bytes,2,rep,name=namespaces"` - // AllowEscalation indicates whether you can request roles and their escalating resources + // allowEscalation indicates whether you can request roles and their escalating resources AllowEscalation bool `json:"allowEscalation" protobuf:"varint,3,opt,name=allowEscalation"` } @@ -203,17 +203,17 @@ type OAuthClientAuthorization struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` - // ClientName references the client that created this authorization + // clientName references the client that created this authorization ClientName string `json:"clientName,omitempty" protobuf:"bytes,2,opt,name=clientName"` - // UserName is the user name that authorized this client + // userName is the user name that authorized this client UserName string `json:"userName,omitempty" protobuf:"bytes,3,opt,name=userName"` - // UserUID is the unique UID associated with this authorization. UserUID and UserName + // userUID is the unique UID associated with this authorization. UserUID and UserName // must both match for this authorization to be valid. UserUID string `json:"userUID,omitempty" protobuf:"bytes,4,opt,name=userUID"` - // Scopes is an array of the granted scopes. + // scopes is an array of the granted scopes. Scopes []string `json:"scopes,omitempty" protobuf:"bytes,5,rep,name=scopes"` } @@ -230,7 +230,7 @@ type OAuthAccessTokenList struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` - // Items is the list of OAuth access tokens + // items is the list of OAuth access tokens Items []OAuthAccessToken `json:"items" protobuf:"bytes,2,rep,name=items"` } @@ -247,7 +247,7 @@ type OAuthAuthorizeTokenList struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` - // Items is the list of OAuth authorization tokens + // items is the list of OAuth authorization tokens Items []OAuthAuthorizeToken `json:"items" protobuf:"bytes,2,rep,name=items"` } @@ -264,7 +264,7 @@ type OAuthClientList struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` - // Items is the list of OAuth clients + // items is the list of OAuth clients Items []OAuthClient `json:"items" protobuf:"bytes,2,rep,name=items"` } @@ -281,7 +281,7 @@ type OAuthClientAuthorizationList struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` - // Items is the list of OAuth client authorizations + // items is the list of OAuth client authorizations Items []OAuthClientAuthorization `json:"items" protobuf:"bytes,2,rep,name=items"` } diff --git a/oauth/v1/zz_generated.swagger_doc_generated.go b/oauth/v1/zz_generated.swagger_doc_generated.go index f62b715c012..171b5221f69 100644 --- a/oauth/v1/zz_generated.swagger_doc_generated.go +++ b/oauth/v1/zz_generated.swagger_doc_generated.go @@ -13,9 +13,9 @@ package v1 // AUTO-GENERATED FUNCTIONS START HERE var map_ClusterRoleScopeRestriction = map[string]string{ "": "ClusterRoleScopeRestriction describes restrictions on cluster role scopes", - "roleNames": "RoleNames is the list of cluster roles that can referenced. * means anything", - "namespaces": "Namespaces is the list of namespaces that can be referenced. * means any of them (including *)", - "allowEscalation": "AllowEscalation indicates whether you can request roles and their escalating resources", + "roleNames": "roleNames is the list of cluster roles that can referenced. * means anything", + "namespaces": "namespaces is the list of namespaces that can be referenced. * means any of them (including *)", + "allowEscalation": "allowEscalation indicates whether you can request roles and their escalating resources", } func (ClusterRoleScopeRestriction) SwaggerDoc() map[string]string { @@ -25,15 +25,15 @@ func (ClusterRoleScopeRestriction) SwaggerDoc() map[string]string { var map_OAuthAccessToken = map[string]string{ "": "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).", "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "clientName": "ClientName references the client that created this token.", - "expiresIn": "ExpiresIn is the seconds from CreationTime before this token expires.", - "scopes": "Scopes is an array of the requested scopes.", - "redirectURI": "RedirectURI is the redirection associated with the token.", - "userName": "UserName is the user name associated with this token", - "userUID": "UserUID is the unique UID associated with this token", - "authorizeToken": "AuthorizeToken contains the token that authorized this token", - "refreshToken": "RefreshToken is the value by which this token can be renewed. Can be blank.", - "inactivityTimeoutSeconds": "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.", + "clientName": "clientName references the client that created this token.", + "expiresIn": "expiresIn is the seconds from CreationTime before this token expires.", + "scopes": "scopes is an array of the requested scopes.", + "redirectURI": "redirectURI is the redirection associated with the token.", + "userName": "userName is the user name associated with this token", + "userUID": "userUID is the unique UID associated with this token", + "authorizeToken": "authorizeToken contains the token that authorized this token", + "refreshToken": "refreshToken is the value by which this token can be renewed. Can be blank.", + "inactivityTimeoutSeconds": "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.", } func (OAuthAccessToken) SwaggerDoc() map[string]string { @@ -43,7 +43,7 @@ func (OAuthAccessToken) SwaggerDoc() map[string]string { var map_OAuthAccessTokenList = map[string]string{ "": "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).", "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "items": "Items is the list of OAuth access tokens", + "items": "items is the list of OAuth access tokens", } func (OAuthAccessTokenList) SwaggerDoc() map[string]string { @@ -53,15 +53,15 @@ func (OAuthAccessTokenList) SwaggerDoc() map[string]string { var map_OAuthAuthorizeToken = map[string]string{ "": "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).", "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "clientName": "ClientName references the client that created this token.", - "expiresIn": "ExpiresIn is the seconds from CreationTime before this token expires.", - "scopes": "Scopes is an array of the requested scopes.", - "redirectURI": "RedirectURI is the redirection associated with the token.", - "state": "State data from request", - "userName": "UserName is the user name associated with this token", - "userUID": "UserUID is the unique UID associated with this token. UserUID and UserName must both match for this token to be valid.", - "codeChallenge": "CodeChallenge is the optional code_challenge associated with this authorization code, as described in rfc7636", - "codeChallengeMethod": "CodeChallengeMethod is the optional code_challenge_method associated with this authorization code, as described in rfc7636", + "clientName": "clientName references the client that created this token.", + "expiresIn": "expiresIn is the seconds from CreationTime before this token expires.", + "scopes": "scopes is an array of the requested scopes.", + "redirectURI": "redirectURI is the redirection associated with the token.", + "state": "state data from request", + "userName": "userName is the user name associated with this token", + "userUID": "userUID is the unique UID associated with this token. UserUID and UserName must both match for this token to be valid.", + "codeChallenge": "codeChallenge is the optional code_challenge associated with this authorization code, as described in rfc7636", + "codeChallengeMethod": "codeChallengeMethod is the optional code_challenge_method associated with this authorization code, as described in rfc7636", } func (OAuthAuthorizeToken) SwaggerDoc() map[string]string { @@ -71,7 +71,7 @@ func (OAuthAuthorizeToken) SwaggerDoc() map[string]string { var map_OAuthAuthorizeTokenList = map[string]string{ "": "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).", "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "items": "Items is the list of OAuth authorization tokens", + "items": "items is the list of OAuth authorization tokens", } func (OAuthAuthorizeTokenList) SwaggerDoc() map[string]string { @@ -81,14 +81,14 @@ func (OAuthAuthorizeTokenList) SwaggerDoc() map[string]string { var map_OAuthClient = map[string]string{ "": "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).", "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "secret": "Secret is the unique secret associated with a client", - "additionalSecrets": "AdditionalSecrets holds other secrets that may be used to identify the client. This is useful for rotation and for service account token validation", - "respondWithChallenges": "RespondWithChallenges indicates whether the client wants authentication needed responses made in the form of challenges instead of redirects", - "redirectURIs": "RedirectURIs is the valid redirection URIs associated with a client", - "grantMethod": "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", - "scopeRestrictions": "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.", - "accessTokenMaxAgeSeconds": "AccessTokenMaxAgeSeconds overrides the default access token max age for tokens granted to this client. 0 means no expiration.", - "accessTokenInactivityTimeoutSeconds": "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", + "secret": "secret is the unique secret associated with a client", + "additionalSecrets": "additionalSecrets holds other secrets that may be used to identify the client. This is useful for rotation and for service account token validation", + "respondWithChallenges": "respondWithChallenges indicates whether the client wants authentication needed responses made in the form of challenges instead of redirects", + "redirectURIs": "redirectURIs is the valid redirection URIs associated with a client", + "grantMethod": "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", + "scopeRestrictions": "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.", + "accessTokenMaxAgeSeconds": "accessTokenMaxAgeSeconds overrides the default access token max age for tokens granted to this client. 0 means no expiration.", + "accessTokenInactivityTimeoutSeconds": "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", } func (OAuthClient) SwaggerDoc() map[string]string { @@ -98,10 +98,10 @@ func (OAuthClient) SwaggerDoc() map[string]string { var map_OAuthClientAuthorization = map[string]string{ "": "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).", "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "clientName": "ClientName references the client that created this authorization", - "userName": "UserName is the user name that authorized this client", - "userUID": "UserUID is the unique UID associated with this authorization. UserUID and UserName must both match for this authorization to be valid.", - "scopes": "Scopes is an array of the granted scopes.", + "clientName": "clientName references the client that created this authorization", + "userName": "userName is the user name that authorized this client", + "userUID": "userUID is the unique UID associated with this authorization. UserUID and UserName must both match for this authorization to be valid.", + "scopes": "scopes is an array of the granted scopes.", } func (OAuthClientAuthorization) SwaggerDoc() map[string]string { @@ -111,7 +111,7 @@ func (OAuthClientAuthorization) SwaggerDoc() map[string]string { var map_OAuthClientAuthorizationList = map[string]string{ "": "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).", "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "items": "Items is the list of OAuth client authorizations", + "items": "items is the list of OAuth client authorizations", } func (OAuthClientAuthorizationList) SwaggerDoc() map[string]string { @@ -121,7 +121,7 @@ func (OAuthClientAuthorizationList) SwaggerDoc() map[string]string { var map_OAuthClientList = map[string]string{ "": "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).", "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "items": "Items is the list of OAuth clients", + "items": "items is the list of OAuth clients", } func (OAuthClientList) SwaggerDoc() map[string]string { @@ -152,7 +152,7 @@ func (RedirectReference) SwaggerDoc() map[string]string { var map_ScopeRestriction = map[string]string{ "": "ScopeRestriction describe one restriction on scopes. Exactly one option must be non-nil.", "literals": "ExactValues means the scope has to match a particular set of strings exactly", - "clusterRole": "ClusterRole describes a set of restrictions for cluster role scoping.", + "clusterRole": "clusterRole describes a set of restrictions for cluster role scoping.", } func (ScopeRestriction) SwaggerDoc() map[string]string { diff --git a/openapi/generated_openapi/zz_generated.openapi.go b/openapi/generated_openapi/zz_generated.openapi.go index 719cf8994d6..d6fa960d11d 100644 --- a/openapi/generated_openapi/zz_generated.openapi.go +++ b/openapi/generated_openapi/zz_generated.openapi.go @@ -1836,7 +1836,7 @@ func schema_openshift_api_apiserver_v1_PerUserAPIRequestCount(ref common.Referen Properties: map[string]spec.Schema{ "username": { SchemaProps: spec.SchemaProps{ - Description: "userName that made the request.", + Description: "username that made the request.", Default: "", Type: []string{"string"}, Format: "", @@ -1920,14 +1920,14 @@ func schema_openshift_api_apps_v1_CustomDeploymentStrategyParams(ref common.Refe Properties: map[string]spec.Schema{ "image": { SchemaProps: spec.SchemaProps{ - Description: "Image specifies a container image which can carry out a deployment.", + Description: "image specifies a container image which can carry out a deployment.", Type: []string{"string"}, Format: "", }, }, "environment": { SchemaProps: spec.SchemaProps{ - Description: "Environment holds the environment which will be given to the container for Image.", + Description: "environment holds the environment which will be given to the container for Image.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -1941,7 +1941,7 @@ func schema_openshift_api_apps_v1_CustomDeploymentStrategyParams(ref common.Refe }, "command": { SchemaProps: spec.SchemaProps{ - Description: "Command is optional and overrides CMD in the container Image.", + Description: "command is optional and overrides CMD in the container Image.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -1971,7 +1971,7 @@ func schema_openshift_api_apps_v1_DeploymentCause(ref common.ReferenceCallback) Properties: map[string]spec.Schema{ "type": { SchemaProps: spec.SchemaProps{ - Description: "Type of the trigger that resulted in the creation of a new deployment", + Description: "type of the trigger that resulted in the creation of a new deployment", Default: "", Type: []string{"string"}, Format: "", @@ -1979,7 +1979,7 @@ func schema_openshift_api_apps_v1_DeploymentCause(ref common.ReferenceCallback) }, "imageTrigger": { SchemaProps: spec.SchemaProps{ - Description: "ImageTrigger contains the image trigger details, if this trigger was fired based on an image change", + Description: "imageTrigger contains the image trigger details, if this trigger was fired based on an image change", Ref: ref("github.com/openshift/api/apps/v1.DeploymentCauseImageTrigger"), }, }, @@ -2001,7 +2001,7 @@ func schema_openshift_api_apps_v1_DeploymentCauseImageTrigger(ref common.Referen Properties: map[string]spec.Schema{ "from": { SchemaProps: spec.SchemaProps{ - Description: "From is a reference to the changed object which triggered a deployment. The field may have the kinds DockerImage, ImageStreamTag, or ImageStreamImage.", + Description: "from is a reference to the changed object which triggered a deployment. The field may have the kinds DockerImage, ImageStreamTag, or ImageStreamImage.", Default: map[string]interface{}{}, Ref: ref("k8s.io/api/core/v1.ObjectReference"), }, @@ -2024,7 +2024,7 @@ func schema_openshift_api_apps_v1_DeploymentCondition(ref common.ReferenceCallba Properties: map[string]spec.Schema{ "type": { SchemaProps: spec.SchemaProps{ - Description: "Type of deployment condition.", + Description: "type of deployment condition.", Default: "", Type: []string{"string"}, Format: "", @@ -2032,7 +2032,7 @@ func schema_openshift_api_apps_v1_DeploymentCondition(ref common.ReferenceCallba }, "status": { SchemaProps: spec.SchemaProps{ - Description: "Status of the condition, one of True, False, Unknown.", + Description: "status of the condition, one of True, False, Unknown.", Default: "", Type: []string{"string"}, Format: "", @@ -2103,14 +2103,14 @@ func schema_openshift_api_apps_v1_DeploymentConfig(ref common.ReferenceCallback) }, "spec": { SchemaProps: spec.SchemaProps{ - Description: "Spec represents a desired deployment state and how to deploy to it.", + Description: "spec represents a desired deployment state and how to deploy to it.", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/apps/v1.DeploymentConfigSpec"), }, }, "status": { SchemaProps: spec.SchemaProps{ - Description: "Status represents the current deployment state.", + Description: "status represents the current deployment state.", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/apps/v1.DeploymentConfigStatus"), }, @@ -2154,7 +2154,7 @@ func schema_openshift_api_apps_v1_DeploymentConfigList(ref common.ReferenceCallb }, "items": { SchemaProps: spec.SchemaProps{ - Description: "Items is a list of deployment configs", + Description: "items is a list of deployment configs", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -2198,7 +2198,7 @@ func schema_openshift_api_apps_v1_DeploymentConfigRollback(ref common.ReferenceC }, "name": { SchemaProps: spec.SchemaProps{ - Description: "Name of the deployment config that will be rolled back.", + Description: "name of the deployment config that will be rolled back.", Default: "", Type: []string{"string"}, Format: "", @@ -2206,7 +2206,7 @@ func schema_openshift_api_apps_v1_DeploymentConfigRollback(ref common.ReferenceC }, "updatedAnnotations": { SchemaProps: spec.SchemaProps{ - Description: "UpdatedAnnotations is a set of new annotations that will be added in the deployment config.", + Description: "updatedAnnotations is a set of new annotations that will be added in the deployment config.", Type: []string{"object"}, AdditionalProperties: &spec.SchemaOrBool{ Allows: true, @@ -2222,7 +2222,7 @@ func schema_openshift_api_apps_v1_DeploymentConfigRollback(ref common.ReferenceC }, "spec": { SchemaProps: spec.SchemaProps{ - Description: "Spec defines the options to rollback generation.", + Description: "spec defines the options to rollback generation.", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/apps/v1.DeploymentConfigRollbackSpec"), }, @@ -2245,21 +2245,21 @@ func schema_openshift_api_apps_v1_DeploymentConfigRollbackSpec(ref common.Refere Properties: map[string]spec.Schema{ "from": { SchemaProps: spec.SchemaProps{ - Description: "From points to a ReplicationController which is a deployment.", + Description: "from points to a ReplicationController which is a deployment.", Default: map[string]interface{}{}, Ref: ref("k8s.io/api/core/v1.ObjectReference"), }, }, "revision": { SchemaProps: spec.SchemaProps{ - Description: "Revision to rollback to. If set to 0, rollback to the last revision.", + Description: "revision to rollback to. If set to 0, rollback to the last revision.", Type: []string{"integer"}, Format: "int64", }, }, "includeTriggers": { SchemaProps: spec.SchemaProps{ - Description: "IncludeTriggers specifies whether to include config Triggers.", + Description: "includeTriggers specifies whether to include config Triggers.", Default: false, Type: []string{"boolean"}, Format: "", @@ -2267,7 +2267,7 @@ func schema_openshift_api_apps_v1_DeploymentConfigRollbackSpec(ref common.Refere }, "includeTemplate": { SchemaProps: spec.SchemaProps{ - Description: "IncludeTemplate specifies whether to include the PodTemplateSpec.", + Description: "includeTemplate specifies whether to include the PodTemplateSpec.", Default: false, Type: []string{"boolean"}, Format: "", @@ -2275,7 +2275,7 @@ func schema_openshift_api_apps_v1_DeploymentConfigRollbackSpec(ref common.Refere }, "includeReplicationMeta": { SchemaProps: spec.SchemaProps{ - Description: "IncludeReplicationMeta specifies whether to include the replica count and selector.", + Description: "includeReplicationMeta specifies whether to include the replica count and selector.", Default: false, Type: []string{"boolean"}, Format: "", @@ -2283,7 +2283,7 @@ func schema_openshift_api_apps_v1_DeploymentConfigRollbackSpec(ref common.Refere }, "includeStrategy": { SchemaProps: spec.SchemaProps{ - Description: "IncludeStrategy specifies whether to include the deployment Strategy.", + Description: "includeStrategy specifies whether to include the deployment Strategy.", Default: false, Type: []string{"boolean"}, Format: "", @@ -2307,21 +2307,21 @@ func schema_openshift_api_apps_v1_DeploymentConfigSpec(ref common.ReferenceCallb Properties: map[string]spec.Schema{ "strategy": { SchemaProps: spec.SchemaProps{ - Description: "Strategy describes how a deployment is executed.", + Description: "strategy describes how a deployment is executed.", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/apps/v1.DeploymentStrategy"), }, }, "minReadySeconds": { SchemaProps: spec.SchemaProps{ - 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)", + 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: []string{"integer"}, Format: "int32", }, }, "triggers": { SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -2335,7 +2335,7 @@ func schema_openshift_api_apps_v1_DeploymentConfigSpec(ref common.ReferenceCallb }, "replicas": { SchemaProps: spec.SchemaProps{ - Description: "Replicas is the number of desired replicas.", + Description: "replicas is the number of desired replicas.", Default: 0, Type: []string{"integer"}, Format: "int32", @@ -2343,14 +2343,14 @@ func schema_openshift_api_apps_v1_DeploymentConfigSpec(ref common.ReferenceCallb }, "revisionHistoryLimit": { SchemaProps: spec.SchemaProps{ - 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.)", + 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: []string{"integer"}, Format: "int32", }, }, "test": { SchemaProps: spec.SchemaProps{ - 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.", + 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.", Default: false, Type: []string{"boolean"}, Format: "", @@ -2358,14 +2358,14 @@ func schema_openshift_api_apps_v1_DeploymentConfigSpec(ref common.ReferenceCallb }, "paused": { SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"boolean"}, Format: "", }, }, "selector": { SchemaProps: spec.SchemaProps{ - Description: "Selector is a label query over pods that should match the Replicas count.", + Description: "selector is a label query over pods that should match the Replicas count.", Type: []string{"object"}, AdditionalProperties: &spec.SchemaOrBool{ Allows: true, @@ -2381,7 +2381,7 @@ func schema_openshift_api_apps_v1_DeploymentConfigSpec(ref common.ReferenceCallb }, "template": { SchemaProps: spec.SchemaProps{ - Description: "Template is the object that describes the pod that will be created if insufficient replicas are detected.", + Description: "template is the object that describes the pod that will be created if insufficient replicas are detected.", Ref: ref("k8s.io/api/core/v1.PodTemplateSpec"), }, }, @@ -2402,7 +2402,7 @@ func schema_openshift_api_apps_v1_DeploymentConfigStatus(ref common.ReferenceCal Properties: map[string]spec.Schema{ "latestVersion": { SchemaProps: spec.SchemaProps{ - Description: "LatestVersion is used to determine whether the current deployment associated with a deployment config is out of sync.", + Description: "latestVersion is used to determine whether the current deployment associated with a deployment config is out of sync.", Default: 0, Type: []string{"integer"}, Format: "int64", @@ -2410,7 +2410,7 @@ func schema_openshift_api_apps_v1_DeploymentConfigStatus(ref common.ReferenceCal }, "observedGeneration": { SchemaProps: spec.SchemaProps{ - Description: "ObservedGeneration is the most recent generation observed by the deployment config controller.", + Description: "observedGeneration is the most recent generation observed by the deployment config controller.", Default: 0, Type: []string{"integer"}, Format: "int64", @@ -2418,7 +2418,7 @@ func schema_openshift_api_apps_v1_DeploymentConfigStatus(ref common.ReferenceCal }, "replicas": { SchemaProps: spec.SchemaProps{ - Description: "Replicas is the total number of pods targeted by this deployment config.", + Description: "replicas is the total number of pods targeted by this deployment config.", Default: 0, Type: []string{"integer"}, Format: "int32", @@ -2426,7 +2426,7 @@ func schema_openshift_api_apps_v1_DeploymentConfigStatus(ref common.ReferenceCal }, "updatedReplicas": { SchemaProps: spec.SchemaProps{ - Description: "UpdatedReplicas is the total number of non-terminated pods targeted by this deployment config that have the desired template spec.", + Description: "updatedReplicas is the total number of non-terminated pods targeted by this deployment config that have the desired template spec.", Default: 0, Type: []string{"integer"}, Format: "int32", @@ -2434,7 +2434,7 @@ func schema_openshift_api_apps_v1_DeploymentConfigStatus(ref common.ReferenceCal }, "availableReplicas": { SchemaProps: spec.SchemaProps{ - Description: "AvailableReplicas is the total number of available pods targeted by this deployment config.", + Description: "availableReplicas is the total number of available pods targeted by this deployment config.", Default: 0, Type: []string{"integer"}, Format: "int32", @@ -2442,7 +2442,7 @@ func schema_openshift_api_apps_v1_DeploymentConfigStatus(ref common.ReferenceCal }, "unavailableReplicas": { SchemaProps: spec.SchemaProps{ - Description: "UnavailableReplicas is the total number of unavailable pods targeted by this deployment config.", + Description: "unavailableReplicas is the total number of unavailable pods targeted by this deployment config.", Default: 0, Type: []string{"integer"}, Format: "int32", @@ -2450,7 +2450,7 @@ func schema_openshift_api_apps_v1_DeploymentConfigStatus(ref common.ReferenceCal }, "details": { SchemaProps: spec.SchemaProps{ - 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", + 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: ref("github.com/openshift/api/apps/v1.DeploymentDetails"), }, }, @@ -2462,7 +2462,7 @@ func schema_openshift_api_apps_v1_DeploymentConfigStatus(ref common.ReferenceCal }, }, SchemaProps: spec.SchemaProps{ - Description: "Conditions represents the latest available observations of a deployment config's current state.", + Description: "conditions represents the latest available observations of a deployment config's current state.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -2499,14 +2499,14 @@ func schema_openshift_api_apps_v1_DeploymentDetails(ref common.ReferenceCallback Properties: map[string]spec.Schema{ "message": { SchemaProps: spec.SchemaProps{ - Description: "Message is the user specified change message, if this deployment was triggered manually by the user", + Description: "message is the user specified change message, if this deployment was triggered manually by the user", Type: []string{"string"}, Format: "", }, }, "causes": { SchemaProps: spec.SchemaProps{ - Description: "Causes are extended data associated with all the causes for creating a new deployment", + Description: "causes are extended data associated with all the causes for creating a new deployment", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -2584,7 +2584,7 @@ func schema_openshift_api_apps_v1_DeploymentLogOptions(ref common.ReferenceCallb }, "follow": { SchemaProps: spec.SchemaProps{ - Description: "Follow if true indicates that the build log should be streamed until the build terminates.", + Description: "follow if true indicates that the build log should be streamed until the build terminates.", Type: []string{"boolean"}, Format: "", }, @@ -2632,14 +2632,14 @@ func schema_openshift_api_apps_v1_DeploymentLogOptions(ref common.ReferenceCallb }, "nowait": { SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"boolean"}, Format: "", }, }, "version": { SchemaProps: spec.SchemaProps{ - Description: "Version of the deployment for which to view logs.", + Description: "version of the deployment for which to view logs.", Type: []string{"integer"}, Format: "int64", }, @@ -2675,7 +2675,7 @@ func schema_openshift_api_apps_v1_DeploymentRequest(ref common.ReferenceCallback }, "name": { SchemaProps: spec.SchemaProps{ - Description: "Name of the deployment config for requesting a new deployment.", + Description: "name of the deployment config for requesting a new deployment.", Default: "", Type: []string{"string"}, Format: "", @@ -2683,7 +2683,7 @@ func schema_openshift_api_apps_v1_DeploymentRequest(ref common.ReferenceCallback }, "latest": { SchemaProps: spec.SchemaProps{ - Description: "Latest will update the deployment config with the latest state from all triggers.", + Description: "latest will update the deployment config with the latest state from all triggers.", Default: false, Type: []string{"boolean"}, Format: "", @@ -2691,7 +2691,7 @@ func schema_openshift_api_apps_v1_DeploymentRequest(ref common.ReferenceCallback }, "force": { SchemaProps: spec.SchemaProps{ - 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.", + 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.", Default: false, Type: []string{"boolean"}, Format: "", @@ -2699,7 +2699,7 @@ func schema_openshift_api_apps_v1_DeploymentRequest(ref common.ReferenceCallback }, "excludeTriggers": { SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -2728,39 +2728,39 @@ func schema_openshift_api_apps_v1_DeploymentStrategy(ref common.ReferenceCallbac Properties: map[string]spec.Schema{ "type": { SchemaProps: spec.SchemaProps{ - Description: "Type is the name of a deployment strategy.", + Description: "type is the name of a deployment strategy.", Type: []string{"string"}, Format: "", }, }, "customParams": { SchemaProps: spec.SchemaProps{ - 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.", + 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: ref("github.com/openshift/api/apps/v1.CustomDeploymentStrategyParams"), }, }, "recreateParams": { SchemaProps: spec.SchemaProps{ - Description: "RecreateParams are the input to the Recreate deployment strategy.", + Description: "recreateParams are the input to the Recreate deployment strategy.", Ref: ref("github.com/openshift/api/apps/v1.RecreateDeploymentStrategyParams"), }, }, "rollingParams": { SchemaProps: spec.SchemaProps{ - Description: "RollingParams are the input to the Rolling deployment strategy.", + Description: "rollingParams are the input to the Rolling deployment strategy.", Ref: ref("github.com/openshift/api/apps/v1.RollingDeploymentStrategyParams"), }, }, "resources": { SchemaProps: spec.SchemaProps{ - Description: "Resources contains resource requirements to execute the deployment and any hooks.", + Description: "resources contains resource requirements to execute the deployment and any hooks.", Default: map[string]interface{}{}, Ref: ref("k8s.io/api/core/v1.ResourceRequirements"), }, }, "labels": { SchemaProps: spec.SchemaProps{ - Description: "Labels is a set of key, value pairs added to custom deployer and lifecycle pre/post hook pods.", + Description: "labels is a set of key, value pairs added to custom deployer and lifecycle pre/post hook pods.", Type: []string{"object"}, AdditionalProperties: &spec.SchemaOrBool{ Allows: true, @@ -2776,7 +2776,7 @@ func schema_openshift_api_apps_v1_DeploymentStrategy(ref common.ReferenceCallbac }, "annotations": { SchemaProps: spec.SchemaProps{ - Description: "Annotations is a set of key, value pairs added to custom deployer and lifecycle pre/post hook pods.", + Description: "annotations is a set of key, value pairs added to custom deployer and lifecycle pre/post hook pods.", Type: []string{"object"}, AdditionalProperties: &spec.SchemaOrBool{ Allows: true, @@ -2792,7 +2792,7 @@ func schema_openshift_api_apps_v1_DeploymentStrategy(ref common.ReferenceCallbac }, "activeDeadlineSeconds": { SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"integer"}, Format: "int64", }, @@ -2814,14 +2814,14 @@ func schema_openshift_api_apps_v1_DeploymentTriggerImageChangeParams(ref common. Properties: map[string]spec.Schema{ "automatic": { SchemaProps: spec.SchemaProps{ - Description: "Automatic means that the detection of a new tag value should result in an image update inside the pod template.", + Description: "automatic means that the detection of a new tag value should result in an image update inside the pod template.", Type: []string{"boolean"}, Format: "", }, }, "containerNames": { SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -2836,14 +2836,14 @@ func schema_openshift_api_apps_v1_DeploymentTriggerImageChangeParams(ref common. }, "from": { SchemaProps: spec.SchemaProps{ - 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.", + 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: map[string]interface{}{}, Ref: ref("k8s.io/api/core/v1.ObjectReference"), }, }, "lastTriggeredImage": { SchemaProps: spec.SchemaProps{ - Description: "LastTriggeredImage is the last image to be triggered.", + Description: "lastTriggeredImage is the last image to be triggered.", Type: []string{"string"}, Format: "", }, @@ -2866,14 +2866,14 @@ func schema_openshift_api_apps_v1_DeploymentTriggerPolicy(ref common.ReferenceCa Properties: map[string]spec.Schema{ "type": { SchemaProps: spec.SchemaProps{ - Description: "Type of the trigger", + Description: "type of the trigger", Type: []string{"string"}, Format: "", }, }, "imageChangeParams": { SchemaProps: spec.SchemaProps{ - Description: "ImageChangeParams represents the parameters for the ImageChange trigger.", + Description: "imageChangeParams represents the parameters for the ImageChange trigger.", Ref: ref("github.com/openshift/api/apps/v1.DeploymentTriggerImageChangeParams"), }, }, @@ -2894,7 +2894,7 @@ func schema_openshift_api_apps_v1_ExecNewPodHook(ref common.ReferenceCallback) c Properties: map[string]spec.Schema{ "command": { SchemaProps: spec.SchemaProps{ - Description: "Command is the action command and its arguments.", + Description: "command is the action command and its arguments.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -2909,7 +2909,7 @@ func schema_openshift_api_apps_v1_ExecNewPodHook(ref common.ReferenceCallback) c }, "env": { SchemaProps: spec.SchemaProps{ - Description: "Env is a set of environment variables to supply to the hook pod's container.", + Description: "env is a set of environment variables to supply to the hook pod's container.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -2923,7 +2923,7 @@ func schema_openshift_api_apps_v1_ExecNewPodHook(ref common.ReferenceCallback) c }, "containerName": { SchemaProps: spec.SchemaProps{ - 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.", + 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.", Default: "", Type: []string{"string"}, Format: "", @@ -2931,7 +2931,7 @@ func schema_openshift_api_apps_v1_ExecNewPodHook(ref common.ReferenceCallback) c }, "volumes": { SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -2962,7 +2962,7 @@ func schema_openshift_api_apps_v1_LifecycleHook(ref common.ReferenceCallback) co Properties: map[string]spec.Schema{ "failurePolicy": { SchemaProps: spec.SchemaProps{ - Description: "FailurePolicy specifies what action to take if the hook fails.", + Description: "failurePolicy specifies what action to take if the hook fails.", Default: "", Type: []string{"string"}, Format: "", @@ -2970,13 +2970,13 @@ func schema_openshift_api_apps_v1_LifecycleHook(ref common.ReferenceCallback) co }, "execNewPod": { SchemaProps: spec.SchemaProps{ - Description: "ExecNewPod specifies the options for a lifecycle hook backed by a pod.", + Description: "execNewPod specifies the options for a lifecycle hook backed by a pod.", Ref: ref("github.com/openshift/api/apps/v1.ExecNewPodHook"), }, }, "tagImages": { SchemaProps: spec.SchemaProps{ - Description: "TagImages instructs the deployer to tag the current image referenced under a container onto an image stream tag.", + Description: "tagImages instructs the deployer to tag the current image referenced under a container onto an image stream tag.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -3006,26 +3006,26 @@ func schema_openshift_api_apps_v1_RecreateDeploymentStrategyParams(ref common.Re Properties: map[string]spec.Schema{ "timeoutSeconds": { SchemaProps: spec.SchemaProps{ - Description: "TimeoutSeconds is the time to wait for updates before giving up. If the value is nil, a default will be used.", + Description: "timeoutSeconds is the time to wait for updates before giving up. If the value is nil, a default will be used.", Type: []string{"integer"}, Format: "int64", }, }, "pre": { SchemaProps: spec.SchemaProps{ - Description: "Pre is a lifecycle hook which is executed before the strategy manipulates the deployment. All LifecycleHookFailurePolicy values are supported.", + Description: "pre is a lifecycle hook which is executed before the strategy manipulates the deployment. All LifecycleHookFailurePolicy values are supported.", Ref: ref("github.com/openshift/api/apps/v1.LifecycleHook"), }, }, "mid": { SchemaProps: spec.SchemaProps{ - 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.", + 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: ref("github.com/openshift/api/apps/v1.LifecycleHook"), }, }, "post": { SchemaProps: spec.SchemaProps{ - Description: "Post is a lifecycle hook which is executed after the strategy has finished all deployment logic. All LifecycleHookFailurePolicy values are supported.", + Description: "post is a lifecycle hook which is executed after the strategy has finished all deployment logic. All LifecycleHookFailurePolicy values are supported.", Ref: ref("github.com/openshift/api/apps/v1.LifecycleHook"), }, }, @@ -3046,46 +3046,46 @@ func schema_openshift_api_apps_v1_RollingDeploymentStrategyParams(ref common.Ref Properties: map[string]spec.Schema{ "updatePeriodSeconds": { SchemaProps: spec.SchemaProps{ - Description: "UpdatePeriodSeconds is the time to wait between individual pod updates. If the value is nil, a default will be used.", + Description: "updatePeriodSeconds is the time to wait between individual pod updates. If the value is nil, a default will be used.", Type: []string{"integer"}, Format: "int64", }, }, "intervalSeconds": { SchemaProps: spec.SchemaProps{ - Description: "IntervalSeconds is the time to wait between polling deployment status after update. If the value is nil, a default will be used.", + Description: "intervalSeconds is the time to wait between polling deployment status after update. If the value is nil, a default will be used.", Type: []string{"integer"}, Format: "int64", }, }, "timeoutSeconds": { SchemaProps: spec.SchemaProps{ - Description: "TimeoutSeconds is the time to wait for updates before giving up. If the value is nil, a default will be used.", + Description: "timeoutSeconds is the time to wait for updates before giving up. If the value is nil, a default will be used.", Type: []string{"integer"}, Format: "int64", }, }, "maxUnavailable": { SchemaProps: spec.SchemaProps{ - 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.", + 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: ref("k8s.io/apimachinery/pkg/util/intstr.IntOrString"), }, }, "maxSurge": { SchemaProps: spec.SchemaProps{ - 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.", + 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: ref("k8s.io/apimachinery/pkg/util/intstr.IntOrString"), }, }, "pre": { SchemaProps: spec.SchemaProps{ - Description: "Pre is a lifecycle hook which is executed before the deployment process begins. All LifecycleHookFailurePolicy values are supported.", + Description: "pre is a lifecycle hook which is executed before the deployment process begins. All LifecycleHookFailurePolicy values are supported.", Ref: ref("github.com/openshift/api/apps/v1.LifecycleHook"), }, }, "post": { SchemaProps: spec.SchemaProps{ - Description: "Post is a lifecycle hook which is executed after the strategy has finished all deployment logic. All LifecycleHookFailurePolicy values are supported.", + Description: "post is a lifecycle hook which is executed after the strategy has finished all deployment logic. All LifecycleHookFailurePolicy values are supported.", Ref: ref("github.com/openshift/api/apps/v1.LifecycleHook"), }, }, @@ -3106,7 +3106,7 @@ func schema_openshift_api_apps_v1_TagImageHook(ref common.ReferenceCallback) com Properties: map[string]spec.Schema{ "containerName": { SchemaProps: spec.SchemaProps{ - 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.", + 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.", Default: "", Type: []string{"string"}, Format: "", @@ -3114,7 +3114,7 @@ func schema_openshift_api_apps_v1_TagImageHook(ref common.ReferenceCallback) com }, "to": { SchemaProps: spec.SchemaProps{ - Description: "To is the target ImageStreamTag to set the container's image onto.", + Description: "to is the target ImageStreamTag to set the container's image onto.", Default: map[string]interface{}{}, Ref: ref("k8s.io/api/core/v1.ObjectReference"), }, @@ -3137,7 +3137,7 @@ func schema_openshift_api_authorization_v1_Action(ref common.ReferenceCallback) Properties: map[string]spec.Schema{ "namespace": { SchemaProps: spec.SchemaProps{ - Description: "Namespace is the namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces", + Description: "namespace is the namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces", Default: "", Type: []string{"string"}, Format: "", @@ -3145,7 +3145,7 @@ func schema_openshift_api_authorization_v1_Action(ref common.ReferenceCallback) }, "verb": { SchemaProps: spec.SchemaProps{ - Description: "Verb is one of: get, list, watch, create, update, delete", + Description: "verb is one of: get, list, watch, create, update, delete", Default: "", Type: []string{"string"}, Format: "", @@ -3169,7 +3169,7 @@ func schema_openshift_api_authorization_v1_Action(ref common.ReferenceCallback) }, "resource": { SchemaProps: spec.SchemaProps{ - Description: "Resource is one of the existing resource types", + Description: "resource is one of the existing resource types", Default: "", Type: []string{"string"}, Format: "", @@ -3177,7 +3177,7 @@ func schema_openshift_api_authorization_v1_Action(ref common.ReferenceCallback) }, "resourceName": { SchemaProps: spec.SchemaProps{ - Description: "ResourceName is the name of the resource being requested for a \"get\" or deleted for a \"delete\"", + Description: "resourceName is the name of the resource being requested for a \"get\" or deleted for a \"delete\"", Default: "", Type: []string{"string"}, Format: "", @@ -3185,7 +3185,7 @@ func schema_openshift_api_authorization_v1_Action(ref common.ReferenceCallback) }, "path": { SchemaProps: spec.SchemaProps{ - Description: "Path is the path of a non resource URL", + Description: "path is the path of a non resource URL", Default: "", Type: []string{"string"}, Format: "", @@ -3193,7 +3193,7 @@ func schema_openshift_api_authorization_v1_Action(ref common.ReferenceCallback) }, "isNonResourceURL": { SchemaProps: spec.SchemaProps{ - Description: "IsNonResourceURL is true if this is a request for a non-resource URL (outside of the resource hierarchy)", + Description: "isNonResourceURL is true if this is a request for a non-resource URL (outside of the resource hierarchy)", Default: false, Type: []string{"boolean"}, Format: "", @@ -3201,7 +3201,7 @@ func schema_openshift_api_authorization_v1_Action(ref common.ReferenceCallback) }, "content": { SchemaProps: spec.SchemaProps{ - Description: "Content is the actual content of the request for create and update", + Description: "content is the actual content of the request for create and update", Ref: ref("k8s.io/apimachinery/pkg/runtime.RawExtension"), }, }, @@ -3244,7 +3244,7 @@ func schema_openshift_api_authorization_v1_ClusterRole(ref common.ReferenceCallb }, "rules": { SchemaProps: spec.SchemaProps{ - Description: "Rules holds all the PolicyRules for this ClusterRole", + Description: "rules holds all the PolicyRules for this ClusterRole", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -3258,7 +3258,7 @@ func schema_openshift_api_authorization_v1_ClusterRole(ref common.ReferenceCallb }, "aggregationRule": { SchemaProps: spec.SchemaProps{ - 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.", + 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: ref("k8s.io/api/rbac/v1.AggregationRule"), }, }, @@ -3301,7 +3301,7 @@ func schema_openshift_api_authorization_v1_ClusterRoleBinding(ref common.Referen }, "userNames": { SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -3316,7 +3316,7 @@ func schema_openshift_api_authorization_v1_ClusterRoleBinding(ref common.Referen }, "groupNames": { SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -3331,7 +3331,7 @@ func schema_openshift_api_authorization_v1_ClusterRoleBinding(ref common.Referen }, "subjects": { SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -3345,7 +3345,7 @@ func schema_openshift_api_authorization_v1_ClusterRoleBinding(ref common.Referen }, "roleRef": { SchemaProps: spec.SchemaProps{ - 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.", + 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: map[string]interface{}{}, Ref: ref("k8s.io/api/core/v1.ObjectReference"), }, @@ -3389,7 +3389,7 @@ func schema_openshift_api_authorization_v1_ClusterRoleBindingList(ref common.Ref }, "items": { SchemaProps: spec.SchemaProps{ - Description: "Items is a list of ClusterRoleBindings", + Description: "items is a list of ClusterRoleBindings", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -3440,7 +3440,7 @@ func schema_openshift_api_authorization_v1_ClusterRoleList(ref common.ReferenceC }, "items": { SchemaProps: spec.SchemaProps{ - Description: "Items is a list of ClusterRoles", + Description: "items is a list of ClusterRoles", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -3470,7 +3470,7 @@ func schema_openshift_api_authorization_v1_GroupRestriction(ref common.Reference Properties: map[string]spec.Schema{ "groups": { SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -3563,7 +3563,7 @@ func schema_openshift_api_authorization_v1_LocalResourceAccessReview(ref common. }, "namespace": { SchemaProps: spec.SchemaProps{ - Description: "Namespace is the namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces", + Description: "namespace is the namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces", Default: "", Type: []string{"string"}, Format: "", @@ -3571,7 +3571,7 @@ func schema_openshift_api_authorization_v1_LocalResourceAccessReview(ref common. }, "verb": { SchemaProps: spec.SchemaProps{ - Description: "Verb is one of: get, list, watch, create, update, delete", + Description: "verb is one of: get, list, watch, create, update, delete", Default: "", Type: []string{"string"}, Format: "", @@ -3595,7 +3595,7 @@ func schema_openshift_api_authorization_v1_LocalResourceAccessReview(ref common. }, "resource": { SchemaProps: spec.SchemaProps{ - Description: "Resource is one of the existing resource types", + Description: "resource is one of the existing resource types", Default: "", Type: []string{"string"}, Format: "", @@ -3603,7 +3603,7 @@ func schema_openshift_api_authorization_v1_LocalResourceAccessReview(ref common. }, "resourceName": { SchemaProps: spec.SchemaProps{ - Description: "ResourceName is the name of the resource being requested for a \"get\" or deleted for a \"delete\"", + Description: "resourceName is the name of the resource being requested for a \"get\" or deleted for a \"delete\"", Default: "", Type: []string{"string"}, Format: "", @@ -3611,7 +3611,7 @@ func schema_openshift_api_authorization_v1_LocalResourceAccessReview(ref common. }, "path": { SchemaProps: spec.SchemaProps{ - Description: "Path is the path of a non resource URL", + Description: "path is the path of a non resource URL", Default: "", Type: []string{"string"}, Format: "", @@ -3619,7 +3619,7 @@ func schema_openshift_api_authorization_v1_LocalResourceAccessReview(ref common. }, "isNonResourceURL": { SchemaProps: spec.SchemaProps{ - Description: "IsNonResourceURL is true if this is a request for a non-resource URL (outside of the resource hierarchy)", + Description: "isNonResourceURL is true if this is a request for a non-resource URL (outside of the resource hierarchy)", Default: false, Type: []string{"boolean"}, Format: "", @@ -3627,7 +3627,7 @@ func schema_openshift_api_authorization_v1_LocalResourceAccessReview(ref common. }, "content": { SchemaProps: spec.SchemaProps{ - Description: "Content is the actual content of the request for create and update", + Description: "content is the actual content of the request for create and update", Ref: ref("k8s.io/apimachinery/pkg/runtime.RawExtension"), }, }, @@ -3670,7 +3670,7 @@ func schema_openshift_api_authorization_v1_LocalSubjectAccessReview(ref common.R }, "namespace": { SchemaProps: spec.SchemaProps{ - Description: "Namespace is the namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces", + Description: "namespace is the namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces", Default: "", Type: []string{"string"}, Format: "", @@ -3678,7 +3678,7 @@ func schema_openshift_api_authorization_v1_LocalSubjectAccessReview(ref common.R }, "verb": { SchemaProps: spec.SchemaProps{ - Description: "Verb is one of: get, list, watch, create, update, delete", + Description: "verb is one of: get, list, watch, create, update, delete", Default: "", Type: []string{"string"}, Format: "", @@ -3702,7 +3702,7 @@ func schema_openshift_api_authorization_v1_LocalSubjectAccessReview(ref common.R }, "resource": { SchemaProps: spec.SchemaProps{ - Description: "Resource is one of the existing resource types", + Description: "resource is one of the existing resource types", Default: "", Type: []string{"string"}, Format: "", @@ -3710,7 +3710,7 @@ func schema_openshift_api_authorization_v1_LocalSubjectAccessReview(ref common.R }, "resourceName": { SchemaProps: spec.SchemaProps{ - Description: "ResourceName is the name of the resource being requested for a \"get\" or deleted for a \"delete\"", + Description: "resourceName is the name of the resource being requested for a \"get\" or deleted for a \"delete\"", Default: "", Type: []string{"string"}, Format: "", @@ -3718,7 +3718,7 @@ func schema_openshift_api_authorization_v1_LocalSubjectAccessReview(ref common.R }, "path": { SchemaProps: spec.SchemaProps{ - Description: "Path is the path of a non resource URL", + Description: "path is the path of a non resource URL", Default: "", Type: []string{"string"}, Format: "", @@ -3726,7 +3726,7 @@ func schema_openshift_api_authorization_v1_LocalSubjectAccessReview(ref common.R }, "isNonResourceURL": { SchemaProps: spec.SchemaProps{ - Description: "IsNonResourceURL is true if this is a request for a non-resource URL (outside of the resource hierarchy)", + Description: "isNonResourceURL is true if this is a request for a non-resource URL (outside of the resource hierarchy)", Default: false, Type: []string{"boolean"}, Format: "", @@ -3734,13 +3734,13 @@ func schema_openshift_api_authorization_v1_LocalSubjectAccessReview(ref common.R }, "content": { SchemaProps: spec.SchemaProps{ - Description: "Content is the actual content of the request for create and update", + Description: "content is the actual content of the request for create and update", Ref: ref("k8s.io/apimachinery/pkg/runtime.RawExtension"), }, }, "user": { SchemaProps: spec.SchemaProps{ - Description: "User is optional. If both User and Groups are empty, the current authenticated user is used.", + Description: "user is optional. If both User and Groups are empty, the current authenticated user is used.", Default: "", Type: []string{"string"}, Format: "", @@ -3748,7 +3748,7 @@ func schema_openshift_api_authorization_v1_LocalSubjectAccessReview(ref common.R }, "groups": { SchemaProps: spec.SchemaProps{ - Description: "Groups is optional. Groups is the list of groups to which the User belongs.", + Description: "groups is optional. Groups is the list of groups to which the User belongs.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -3763,7 +3763,7 @@ func schema_openshift_api_authorization_v1_LocalSubjectAccessReview(ref common.R }, "scopes": { SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -3794,7 +3794,7 @@ func schema_openshift_api_authorization_v1_NamedClusterRole(ref common.Reference Properties: map[string]spec.Schema{ "name": { SchemaProps: spec.SchemaProps{ - Description: "Name is the name of the cluster role", + Description: "name is the name of the cluster role", Default: "", Type: []string{"string"}, Format: "", @@ -3802,7 +3802,7 @@ func schema_openshift_api_authorization_v1_NamedClusterRole(ref common.Reference }, "role": { SchemaProps: spec.SchemaProps{ - Description: "Role is the cluster role being named", + Description: "role is the cluster role being named", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/authorization/v1.ClusterRole"), }, @@ -3825,7 +3825,7 @@ func schema_openshift_api_authorization_v1_NamedClusterRoleBinding(ref common.Re Properties: map[string]spec.Schema{ "name": { SchemaProps: spec.SchemaProps{ - Description: "Name is the name of the cluster role binding", + Description: "name is the name of the cluster role binding", Default: "", Type: []string{"string"}, Format: "", @@ -3833,7 +3833,7 @@ func schema_openshift_api_authorization_v1_NamedClusterRoleBinding(ref common.Re }, "roleBinding": { SchemaProps: spec.SchemaProps{ - Description: "RoleBinding is the cluster role binding being named", + Description: "roleBinding is the cluster role binding being named", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/authorization/v1.ClusterRoleBinding"), }, @@ -3856,7 +3856,7 @@ func schema_openshift_api_authorization_v1_NamedRole(ref common.ReferenceCallbac Properties: map[string]spec.Schema{ "name": { SchemaProps: spec.SchemaProps{ - Description: "Name is the name of the role", + Description: "name is the name of the role", Default: "", Type: []string{"string"}, Format: "", @@ -3864,7 +3864,7 @@ func schema_openshift_api_authorization_v1_NamedRole(ref common.ReferenceCallbac }, "role": { SchemaProps: spec.SchemaProps{ - Description: "Role is the role being named", + Description: "role is the role being named", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/authorization/v1.Role"), }, @@ -3887,7 +3887,7 @@ func schema_openshift_api_authorization_v1_NamedRoleBinding(ref common.Reference Properties: map[string]spec.Schema{ "name": { SchemaProps: spec.SchemaProps{ - Description: "Name is the name of the role binding", + Description: "name is the name of the role binding", Default: "", Type: []string{"string"}, Format: "", @@ -3895,7 +3895,7 @@ func schema_openshift_api_authorization_v1_NamedRoleBinding(ref common.Reference }, "roleBinding": { SchemaProps: spec.SchemaProps{ - Description: "RoleBinding is the role binding being named", + Description: "roleBinding is the role binding being named", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/authorization/v1.RoleBinding"), }, @@ -3918,7 +3918,7 @@ func schema_openshift_api_authorization_v1_PolicyRule(ref common.ReferenceCallba Properties: map[string]spec.Schema{ "verbs": { SchemaProps: spec.SchemaProps{ - Description: "Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. VerbAll represents all kinds.", + Description: "verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. VerbAll represents all kinds.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -3933,13 +3933,13 @@ func schema_openshift_api_authorization_v1_PolicyRule(ref common.ReferenceCallba }, "attributeRestrictions": { SchemaProps: spec.SchemaProps{ - 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.", + 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: ref("k8s.io/apimachinery/pkg/runtime.RawExtension"), }, }, "apiGroups": { SchemaProps: spec.SchemaProps{ - 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", + 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: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -3954,7 +3954,7 @@ func schema_openshift_api_authorization_v1_PolicyRule(ref common.ReferenceCallba }, "resources": { SchemaProps: spec.SchemaProps{ - Description: "Resources is a list of resources this rule applies to. ResourceAll represents all resources.", + Description: "resources is a list of resources this rule applies to. ResourceAll represents all resources.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -3969,7 +3969,7 @@ func schema_openshift_api_authorization_v1_PolicyRule(ref common.ReferenceCallba }, "resourceNames": { SchemaProps: spec.SchemaProps{ - Description: "ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.", + Description: "resourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -4036,7 +4036,7 @@ func schema_openshift_api_authorization_v1_ResourceAccessReview(ref common.Refer }, "namespace": { SchemaProps: spec.SchemaProps{ - Description: "Namespace is the namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces", + Description: "namespace is the namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces", Default: "", Type: []string{"string"}, Format: "", @@ -4044,7 +4044,7 @@ func schema_openshift_api_authorization_v1_ResourceAccessReview(ref common.Refer }, "verb": { SchemaProps: spec.SchemaProps{ - Description: "Verb is one of: get, list, watch, create, update, delete", + Description: "verb is one of: get, list, watch, create, update, delete", Default: "", Type: []string{"string"}, Format: "", @@ -4068,7 +4068,7 @@ func schema_openshift_api_authorization_v1_ResourceAccessReview(ref common.Refer }, "resource": { SchemaProps: spec.SchemaProps{ - Description: "Resource is one of the existing resource types", + Description: "resource is one of the existing resource types", Default: "", Type: []string{"string"}, Format: "", @@ -4076,7 +4076,7 @@ func schema_openshift_api_authorization_v1_ResourceAccessReview(ref common.Refer }, "resourceName": { SchemaProps: spec.SchemaProps{ - Description: "ResourceName is the name of the resource being requested for a \"get\" or deleted for a \"delete\"", + Description: "resourceName is the name of the resource being requested for a \"get\" or deleted for a \"delete\"", Default: "", Type: []string{"string"}, Format: "", @@ -4084,7 +4084,7 @@ func schema_openshift_api_authorization_v1_ResourceAccessReview(ref common.Refer }, "path": { SchemaProps: spec.SchemaProps{ - Description: "Path is the path of a non resource URL", + Description: "path is the path of a non resource URL", Default: "", Type: []string{"string"}, Format: "", @@ -4092,7 +4092,7 @@ func schema_openshift_api_authorization_v1_ResourceAccessReview(ref common.Refer }, "isNonResourceURL": { SchemaProps: spec.SchemaProps{ - Description: "IsNonResourceURL is true if this is a request for a non-resource URL (outside of the resource hierarchy)", + Description: "isNonResourceURL is true if this is a request for a non-resource URL (outside of the resource hierarchy)", Default: false, Type: []string{"boolean"}, Format: "", @@ -4100,7 +4100,7 @@ func schema_openshift_api_authorization_v1_ResourceAccessReview(ref common.Refer }, "content": { SchemaProps: spec.SchemaProps{ - Description: "Content is the actual content of the request for create and update", + Description: "content is the actual content of the request for create and update", Ref: ref("k8s.io/apimachinery/pkg/runtime.RawExtension"), }, }, @@ -4136,7 +4136,7 @@ func schema_openshift_api_authorization_v1_ResourceAccessReviewResponse(ref comm }, "namespace": { SchemaProps: spec.SchemaProps{ - Description: "Namespace is the namespace used for the access review", + Description: "namespace is the namespace used for the access review", Type: []string{"string"}, Format: "", }, @@ -4216,7 +4216,7 @@ func schema_openshift_api_authorization_v1_Role(ref common.ReferenceCallback) co }, "rules": { SchemaProps: spec.SchemaProps{ - Description: "Rules holds all the PolicyRules for this Role", + Description: "rules holds all the PolicyRules for this Role", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -4267,7 +4267,7 @@ func schema_openshift_api_authorization_v1_RoleBinding(ref common.ReferenceCallb }, "userNames": { SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -4282,7 +4282,7 @@ func schema_openshift_api_authorization_v1_RoleBinding(ref common.ReferenceCallb }, "groupNames": { SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -4297,7 +4297,7 @@ func schema_openshift_api_authorization_v1_RoleBinding(ref common.ReferenceCallb }, "subjects": { SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -4311,7 +4311,7 @@ func schema_openshift_api_authorization_v1_RoleBinding(ref common.ReferenceCallb }, "roleRef": { SchemaProps: spec.SchemaProps{ - 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.", + 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: map[string]interface{}{}, Ref: ref("k8s.io/api/core/v1.ObjectReference"), }, @@ -4355,7 +4355,7 @@ func schema_openshift_api_authorization_v1_RoleBindingList(ref common.ReferenceC }, "items": { SchemaProps: spec.SchemaProps{ - Description: "Items is a list of RoleBindings", + Description: "items is a list of RoleBindings", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -4406,7 +4406,7 @@ func schema_openshift_api_authorization_v1_RoleBindingRestriction(ref common.Ref }, "spec": { SchemaProps: spec.SchemaProps{ - Description: "Spec defines the matcher.", + Description: "spec defines the matcher.", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/authorization/v1.RoleBindingRestrictionSpec"), }, @@ -4450,7 +4450,7 @@ func schema_openshift_api_authorization_v1_RoleBindingRestrictionList(ref common }, "items": { SchemaProps: spec.SchemaProps{ - Description: "Items is a list of RoleBindingRestriction objects.", + Description: "items is a list of RoleBindingRestriction objects.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -4480,19 +4480,19 @@ func schema_openshift_api_authorization_v1_RoleBindingRestrictionSpec(ref common Properties: map[string]spec.Schema{ "userrestriction": { SchemaProps: spec.SchemaProps{ - Description: "UserRestriction matches against user subjects.", + Description: "userrestriction matches against user subjects.", Ref: ref("github.com/openshift/api/authorization/v1.UserRestriction"), }, }, "grouprestriction": { SchemaProps: spec.SchemaProps{ - Description: "GroupRestriction matches against group subjects.", + Description: "grouprestriction matches against group subjects.", Ref: ref("github.com/openshift/api/authorization/v1.GroupRestriction"), }, }, "serviceaccountrestriction": { SchemaProps: spec.SchemaProps{ - Description: "ServiceAccountRestriction matches against service-account subjects.", + Description: "serviceaccountrestriction matches against service-account subjects.", Ref: ref("github.com/openshift/api/authorization/v1.ServiceAccountRestriction"), }, }, @@ -4535,7 +4535,7 @@ func schema_openshift_api_authorization_v1_RoleList(ref common.ReferenceCallback }, "items": { SchemaProps: spec.SchemaProps{ - Description: "Items is a list of Roles", + Description: "items is a list of Roles", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -4586,14 +4586,14 @@ func schema_openshift_api_authorization_v1_SelfSubjectRulesReview(ref common.Ref }, "spec": { SchemaProps: spec.SchemaProps{ - Description: "Spec adds information about how to conduct the check", + Description: "spec adds information about how to conduct the check", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/authorization/v1.SelfSubjectRulesReviewSpec"), }, }, "status": { SchemaProps: spec.SchemaProps{ - Description: "Status is completed by the server to tell which permissions you have", + Description: "status is completed by the server to tell which permissions you have", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/authorization/v1.SubjectRulesReviewStatus"), }, @@ -4616,7 +4616,7 @@ func schema_openshift_api_authorization_v1_SelfSubjectRulesReviewSpec(ref common Properties: map[string]spec.Schema{ "scopes": { SchemaProps: spec.SchemaProps{ - 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\".", + 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: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -4645,7 +4645,7 @@ func schema_openshift_api_authorization_v1_ServiceAccountReference(ref common.Re Properties: map[string]spec.Schema{ "name": { SchemaProps: spec.SchemaProps{ - Description: "Name is the name of the service account.", + Description: "name is the name of the service account.", Default: "", Type: []string{"string"}, Format: "", @@ -4653,7 +4653,7 @@ func schema_openshift_api_authorization_v1_ServiceAccountReference(ref common.Re }, "namespace": { SchemaProps: spec.SchemaProps{ - 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.", + 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.", Default: "", Type: []string{"string"}, Format: "", @@ -4675,7 +4675,7 @@ func schema_openshift_api_authorization_v1_ServiceAccountRestriction(ref common. Properties: map[string]spec.Schema{ "serviceaccounts": { SchemaProps: spec.SchemaProps{ - Description: "ServiceAccounts specifies a list of literal service-account names.", + Description: "serviceaccounts specifies a list of literal service-account names.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -4689,7 +4689,7 @@ func schema_openshift_api_authorization_v1_ServiceAccountRestriction(ref common. }, "namespaces": { SchemaProps: spec.SchemaProps{ - Description: "Namespaces specifies a list of literal namespace names.", + Description: "namespaces specifies a list of literal namespace names.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -4741,7 +4741,7 @@ func schema_openshift_api_authorization_v1_SubjectAccessReview(ref common.Refere }, "namespace": { SchemaProps: spec.SchemaProps{ - Description: "Namespace is the namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces", + Description: "namespace is the namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces", Default: "", Type: []string{"string"}, Format: "", @@ -4749,7 +4749,7 @@ func schema_openshift_api_authorization_v1_SubjectAccessReview(ref common.Refere }, "verb": { SchemaProps: spec.SchemaProps{ - Description: "Verb is one of: get, list, watch, create, update, delete", + Description: "verb is one of: get, list, watch, create, update, delete", Default: "", Type: []string{"string"}, Format: "", @@ -4773,7 +4773,7 @@ func schema_openshift_api_authorization_v1_SubjectAccessReview(ref common.Refere }, "resource": { SchemaProps: spec.SchemaProps{ - Description: "Resource is one of the existing resource types", + Description: "resource is one of the existing resource types", Default: "", Type: []string{"string"}, Format: "", @@ -4781,7 +4781,7 @@ func schema_openshift_api_authorization_v1_SubjectAccessReview(ref common.Refere }, "resourceName": { SchemaProps: spec.SchemaProps{ - Description: "ResourceName is the name of the resource being requested for a \"get\" or deleted for a \"delete\"", + Description: "resourceName is the name of the resource being requested for a \"get\" or deleted for a \"delete\"", Default: "", Type: []string{"string"}, Format: "", @@ -4789,7 +4789,7 @@ func schema_openshift_api_authorization_v1_SubjectAccessReview(ref common.Refere }, "path": { SchemaProps: spec.SchemaProps{ - Description: "Path is the path of a non resource URL", + Description: "path is the path of a non resource URL", Default: "", Type: []string{"string"}, Format: "", @@ -4797,7 +4797,7 @@ func schema_openshift_api_authorization_v1_SubjectAccessReview(ref common.Refere }, "isNonResourceURL": { SchemaProps: spec.SchemaProps{ - Description: "IsNonResourceURL is true if this is a request for a non-resource URL (outside of the resource hierarchy)", + Description: "isNonResourceURL is true if this is a request for a non-resource URL (outside of the resource hierarchy)", Default: false, Type: []string{"boolean"}, Format: "", @@ -4805,13 +4805,13 @@ func schema_openshift_api_authorization_v1_SubjectAccessReview(ref common.Refere }, "content": { SchemaProps: spec.SchemaProps{ - Description: "Content is the actual content of the request for create and update", + Description: "content is the actual content of the request for create and update", Ref: ref("k8s.io/apimachinery/pkg/runtime.RawExtension"), }, }, "user": { SchemaProps: spec.SchemaProps{ - Description: "User is optional. If both User and Groups are empty, the current authenticated user is used.", + Description: "user is optional. If both User and Groups are empty, the current authenticated user is used.", Default: "", Type: []string{"string"}, Format: "", @@ -4834,7 +4834,7 @@ func schema_openshift_api_authorization_v1_SubjectAccessReview(ref common.Refere }, "scopes": { SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -4879,14 +4879,14 @@ func schema_openshift_api_authorization_v1_SubjectAccessReviewResponse(ref commo }, "namespace": { SchemaProps: spec.SchemaProps{ - Description: "Namespace is the namespace used for the access review", + Description: "namespace is the namespace used for the access review", Type: []string{"string"}, Format: "", }, }, "allowed": { SchemaProps: spec.SchemaProps{ - Description: "Allowed is required. True if the action would be allowed, false otherwise.", + Description: "allowed is required. True if the action would be allowed, false otherwise.", Default: false, Type: []string{"boolean"}, Format: "", @@ -4894,14 +4894,14 @@ func schema_openshift_api_authorization_v1_SubjectAccessReviewResponse(ref commo }, "reason": { SchemaProps: spec.SchemaProps{ - Description: "Reason is optional. It indicates why a request was allowed or denied.", + Description: "reason is optional. It indicates why a request was allowed or denied.", Type: []string{"string"}, Format: "", }, }, "evaluationError": { SchemaProps: spec.SchemaProps{ - 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.", + 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{"string"}, Format: "", }, @@ -4943,14 +4943,14 @@ func schema_openshift_api_authorization_v1_SubjectRulesReview(ref common.Referen }, "spec": { SchemaProps: spec.SchemaProps{ - Description: "Spec adds information about how to conduct the check", + Description: "spec adds information about how to conduct the check", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/authorization/v1.SubjectRulesReviewSpec"), }, }, "status": { SchemaProps: spec.SchemaProps{ - Description: "Status is completed by the server to tell which permissions you have", + Description: "status is completed by the server to tell which permissions you have", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/authorization/v1.SubjectRulesReviewStatus"), }, @@ -4973,7 +4973,7 @@ func schema_openshift_api_authorization_v1_SubjectRulesReviewSpec(ref common.Ref Properties: map[string]spec.Schema{ "user": { SchemaProps: spec.SchemaProps{ - Description: "User is optional. At least one of User and Groups must be specified.", + Description: "user is optional. At least one of User and Groups must be specified.", Default: "", Type: []string{"string"}, Format: "", @@ -4981,7 +4981,7 @@ func schema_openshift_api_authorization_v1_SubjectRulesReviewSpec(ref common.Ref }, "groups": { SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -4996,7 +4996,7 @@ func schema_openshift_api_authorization_v1_SubjectRulesReviewSpec(ref common.Ref }, "scopes": { SchemaProps: spec.SchemaProps{ - Description: "Scopes to use for the evaluation. Empty means \"use the unscoped (full) permissions of the user/groups\".", + Description: "scopes to use for the evaluation. Empty means \"use the unscoped (full) permissions of the user/groups\".", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -5025,7 +5025,7 @@ func schema_openshift_api_authorization_v1_SubjectRulesReviewStatus(ref common.R Properties: map[string]spec.Schema{ "rules": { SchemaProps: spec.SchemaProps{ - Description: "Rules is the list of rules (no particular sort) that are allowed for the subject", + Description: "rules is the list of rules (no particular sort) that are allowed for the subject", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -5039,7 +5039,7 @@ func schema_openshift_api_authorization_v1_SubjectRulesReviewStatus(ref common.R }, "evaluationError": { SchemaProps: spec.SchemaProps{ - Description: "EvaluationError can appear in combination with Rules. It means some error happened during evaluation that may have prevented additional rules from being populated.", + 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{"string"}, Format: "", }, @@ -5062,7 +5062,7 @@ func schema_openshift_api_authorization_v1_UserRestriction(ref common.ReferenceC Properties: map[string]spec.Schema{ "users": { SchemaProps: spec.SchemaProps{ - Description: "Users specifies a list of literal user names.", + Description: "users specifies a list of literal user names.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -5077,7 +5077,7 @@ func schema_openshift_api_authorization_v1_UserRestriction(ref common.ReferenceC }, "groups": { SchemaProps: spec.SchemaProps{ - Description: "Groups specifies a list of literal group names.", + Description: "groups specifies a list of literal group names.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -5227,13 +5227,13 @@ func schema_openshift_api_build_v1_BitbucketWebHookCause(ref common.ReferenceCal Properties: map[string]spec.Schema{ "revision": { SchemaProps: spec.SchemaProps{ - Description: "Revision is the git source revision information of the trigger.", + Description: "revision is the git source revision information of the trigger.", Ref: ref("github.com/openshift/api/build/v1.SourceRevision"), }, }, "secret": { SchemaProps: spec.SchemaProps{ - Description: "Secret is the obfuscated webhook secret that triggered a build.", + Description: "secret is the obfuscated webhook secret that triggered a build.", Type: []string{"string"}, Format: "", }, @@ -5305,7 +5305,7 @@ func schema_openshift_api_build_v1_BuildCondition(ref common.ReferenceCallback) Properties: map[string]spec.Schema{ "type": { SchemaProps: spec.SchemaProps{ - Description: "Type of build condition.", + Description: "type of build condition.", Default: "", Type: []string{"string"}, Format: "", @@ -5313,7 +5313,7 @@ func schema_openshift_api_build_v1_BuildCondition(ref common.ReferenceCallback) }, "status": { SchemaProps: spec.SchemaProps{ - Description: "Status of the condition, one of True, False, Unknown.", + Description: "status of the condition, one of True, False, Unknown.", Default: "", Type: []string{"string"}, Format: "", @@ -5479,7 +5479,7 @@ func schema_openshift_api_build_v1_BuildConfigSpec(ref common.ReferenceCallback) }, "runPolicy": { SchemaProps: spec.SchemaProps{ - 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\".", + 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{"string"}, Format: "", }, @@ -5602,7 +5602,7 @@ func schema_openshift_api_build_v1_BuildConfigStatus(ref common.ReferenceCallbac }, "imageChangeTriggers": { SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -5779,7 +5779,7 @@ func schema_openshift_api_build_v1_BuildLogOptions(ref common.ReferenceCallback) }, "nowait": { SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"boolean"}, Format: "", }, @@ -5821,7 +5821,7 @@ func schema_openshift_api_build_v1_BuildOutput(ref common.ReferenceCallback) com }, "pushSecret": { SchemaProps: spec.SchemaProps{ - 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).", + 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: ref("k8s.io/api/core/v1.LocalObjectReference"), }, }, @@ -5986,13 +5986,13 @@ func schema_openshift_api_build_v1_BuildRequest(ref common.ReferenceCallback) co }, "dockerStrategyOptions": { SchemaProps: spec.SchemaProps{ - Description: "DockerStrategyOptions contains additional docker-strategy specific options for the build", + Description: "dockerStrategyOptions contains additional docker-strategy specific options for the build", Ref: ref("github.com/openshift/api/build/v1.DockerStrategyOptions"), }, }, "sourceStrategyOptions": { SchemaProps: spec.SchemaProps{ - Description: "SourceStrategyOptions contains additional source-strategy specific options for the build", + Description: "sourceStrategyOptions contains additional source-strategy specific options for the build", Ref: ref("github.com/openshift/api/build/v1.SourceStrategyOptions"), }, }, @@ -6312,7 +6312,7 @@ func schema_openshift_api_build_v1_BuildStatus(ref common.ReferenceCallback) com }, }, SchemaProps: spec.SchemaProps{ - Description: "Conditions represents the latest available observations of a build's current state.", + Description: "conditions represents the latest available observations of a build's current state.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -6408,7 +6408,7 @@ func schema_openshift_api_build_v1_BuildStrategy(ref common.ReferenceCallback) c }, "jenkinsPipelineStrategy": { SchemaProps: spec.SchemaProps{ - Description: "JenkinsPipelineStrategy holds the parameters to the Jenkins Pipeline build strategy. Deprecated: use OpenShift Pipelines", + Description: "jenkinsPipelineStrategy holds the parameters to the Jenkins Pipeline build strategy. Deprecated: use OpenShift Pipelines", Ref: ref("github.com/openshift/api/build/v1.JenkinsPipelineBuildStrategy"), }, }, @@ -6442,7 +6442,7 @@ func schema_openshift_api_build_v1_BuildTriggerCause(ref common.ReferenceCallbac }, "githubWebHook": { SchemaProps: spec.SchemaProps{ - Description: "gitHubWebHook represents data for a GitHub webhook that fired a specific build.", + Description: "githubWebHook represents data for a GitHub webhook that fired a specific build.", Ref: ref("github.com/openshift/api/build/v1.GitHubWebHookCause"), }, }, @@ -6454,13 +6454,13 @@ func schema_openshift_api_build_v1_BuildTriggerCause(ref common.ReferenceCallbac }, "gitlabWebHook": { SchemaProps: spec.SchemaProps{ - Description: "GitLabWebHook represents data for a GitLab webhook that fired a specific build.", + Description: "gitlabWebHook represents data for a GitLab webhook that fired a specific build.", Ref: ref("github.com/openshift/api/build/v1.GitLabWebHookCause"), }, }, "bitbucketWebHook": { SchemaProps: spec.SchemaProps{ - Description: "BitbucketWebHook represents data for a Bitbucket webhook that fired a specific build.", + Description: "bitbucketWebHook represents data for a Bitbucket webhook that fired a specific build.", Ref: ref("github.com/openshift/api/build/v1.BitbucketWebHookCause"), }, }, @@ -6748,13 +6748,13 @@ func schema_openshift_api_build_v1_CommonWebHookCause(ref common.ReferenceCallba Properties: map[string]spec.Schema{ "revision": { SchemaProps: spec.SchemaProps{ - Description: "Revision is the git source revision information of the trigger.", + Description: "revision is the git source revision information of the trigger.", Ref: ref("github.com/openshift/api/build/v1.SourceRevision"), }, }, "secret": { SchemaProps: spec.SchemaProps{ - Description: "Secret is the obfuscated webhook secret that triggered a build.", + Description: "secret is the obfuscated webhook secret that triggered a build.", Type: []string{"string"}, Format: "", }, @@ -7082,7 +7082,7 @@ func schema_openshift_api_build_v1_GenericWebHookEvent(ref common.ReferenceCallb }, "dockerStrategyOptions": { SchemaProps: spec.SchemaProps{ - Description: "DockerStrategyOptions contains additional docker-strategy specific options for the build", + Description: "dockerStrategyOptions contains additional docker-strategy specific options for the build", Ref: ref("github.com/openshift/api/build/v1.DockerStrategyOptions"), }, }, @@ -7245,7 +7245,7 @@ func schema_openshift_api_build_v1_GitInfo(ref common.ReferenceCallback) common. }, "refs": { SchemaProps: spec.SchemaProps{ - 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", + 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: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -7275,13 +7275,13 @@ func schema_openshift_api_build_v1_GitLabWebHookCause(ref common.ReferenceCallba Properties: map[string]spec.Schema{ "revision": { SchemaProps: spec.SchemaProps{ - Description: "Revision is the git source revision information of the trigger.", + Description: "revision is the git source revision information of the trigger.", Ref: ref("github.com/openshift/api/build/v1.SourceRevision"), }, }, "secret": { SchemaProps: spec.SchemaProps{ - Description: "Secret is the obfuscated webhook secret that triggered a build.", + Description: "secret is the obfuscated webhook secret that triggered a build.", Type: []string{"string"}, Format: "", }, @@ -7668,14 +7668,14 @@ func schema_openshift_api_build_v1_JenkinsPipelineBuildStrategy(ref common.Refer Properties: map[string]spec.Schema{ "jenkinsfilePath": { SchemaProps: spec.SchemaProps{ - 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.", + 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{"string"}, Format: "", }, }, "jenkinsfile": { SchemaProps: spec.SchemaProps{ - Description: "Jenkinsfile defines the optional raw contents of a Jenkinsfile which defines a Jenkins pipeline build.", + Description: "jenkinsfile defines the optional raw contents of a Jenkinsfile which defines a Jenkins pipeline build.", Type: []string{"string"}, Format: "", }, @@ -7775,7 +7775,7 @@ func schema_openshift_api_build_v1_SecretLocalReference(ref common.ReferenceCall Properties: map[string]spec.Schema{ "name": { SchemaProps: spec.SchemaProps{ - Description: "Name is the name of the resource in the same namespace being referenced", + Description: "name is the name of the resource in the same namespace being referenced", Default: "", Type: []string{"string"}, Format: "", @@ -7951,7 +7951,7 @@ func schema_openshift_api_build_v1_SourceRevision(ref common.ReferenceCallback) }, "git": { SchemaProps: spec.SchemaProps{ - Description: "Git contains information about git-based build source", + Description: "git contains information about git-based build source", Ref: ref("github.com/openshift/api/build/v1.GitSourceRevision"), }, }, @@ -8508,6 +8508,7 @@ func schema_openshift_api_config_v1_AWSIngressSpec(ref common.ReferenceCallback) }, }, }, + Required: []string{"type"}, }, VendorExtensible: spec.VendorExtensible{ Extensions: spec.Extensions{ @@ -8579,7 +8580,7 @@ func schema_openshift_api_config_v1_AWSPlatformStatus(ref common.ReferenceCallba }, }, SchemaProps: spec.SchemaProps{ - Description: "ServiceEndpoints list contains custom endpoints which will override default service endpoint of AWS Services. There must be only one ServiceEndpoint for a service.", + 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: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -8753,7 +8754,7 @@ func schema_openshift_api_config_v1_AdmissionPluginConfig(ref common.ReferenceCa Properties: map[string]spec.Schema{ "location": { SchemaProps: spec.SchemaProps{ - Description: "Location is the path to a configuration file that contains the plugin's configuration", + Description: "location is the path to a configuration file that contains the plugin's configuration", Default: "", Type: []string{"string"}, Format: "", @@ -8761,7 +8762,7 @@ func schema_openshift_api_config_v1_AdmissionPluginConfig(ref common.ReferenceCa }, "configuration": { SchemaProps: spec.SchemaProps{ - 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.", + 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: ref("k8s.io/apimachinery/pkg/runtime.RawExtension"), }, }, @@ -8960,7 +8961,7 @@ func schema_openshift_api_config_v1_AuditConfig(ref common.ReferenceCallback) co }, "policyFile": { SchemaProps: spec.SchemaProps{ - Description: "PolicyFile is a path to the file that defines the audit policy configuration.", + Description: "policyFile is a path to the file that defines the audit policy configuration.", Default: "", Type: []string{"string"}, Format: "", @@ -8968,7 +8969,7 @@ func schema_openshift_api_config_v1_AuditConfig(ref common.ReferenceCallback) co }, "policyConfiguration": { SchemaProps: spec.SchemaProps{ - 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.", + 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: ref("k8s.io/apimachinery/pkg/runtime.RawExtension"), }, }, @@ -9199,7 +9200,7 @@ func schema_openshift_api_config_v1_AuthenticationSpec(ref common.ReferenceCallb }, }, SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -9243,7 +9244,7 @@ func schema_openshift_api_config_v1_AuthenticationStatus(ref common.ReferenceCal }, }, SchemaProps: spec.SchemaProps{ - Description: "OIDCClients is where participating operators place the current OIDC client status for OIDC clients that can be customized by the cluster-admin.", + Description: "oidcClients is where participating operators place the current OIDC client status for OIDC clients that can be customized by the cluster-admin.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -9652,7 +9653,7 @@ func schema_openshift_api_config_v1_Build(ref common.ReferenceCallback) common.O }, "spec": { SchemaProps: spec.SchemaProps{ - Description: "Spec holds user-settable values for the build controller configuration", + Description: "spec holds user-settable values for the build controller configuration", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/config/v1.BuildSpec"), }, @@ -9674,19 +9675,19 @@ func schema_openshift_api_config_v1_BuildDefaults(ref common.ReferenceCallback) Properties: map[string]spec.Schema{ "defaultProxy": { SchemaProps: spec.SchemaProps{ - 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.", + 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: ref("github.com/openshift/api/config/v1.ProxySpec"), }, }, "gitProxy": { SchemaProps: spec.SchemaProps{ - 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.", + 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: ref("github.com/openshift/api/config/v1.ProxySpec"), }, }, "env": { SchemaProps: spec.SchemaProps{ - 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", + 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: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -9700,7 +9701,7 @@ func schema_openshift_api_config_v1_BuildDefaults(ref common.ReferenceCallback) }, "imageLabels": { SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -9714,7 +9715,7 @@ func schema_openshift_api_config_v1_BuildDefaults(ref common.ReferenceCallback) }, "resources": { SchemaProps: spec.SchemaProps{ - Description: "Resources defines resource requirements to execute the build.", + Description: "resources defines resource requirements to execute the build.", Default: map[string]interface{}{}, Ref: ref("k8s.io/api/core/v1.ResourceRequirements"), }, @@ -9785,7 +9786,7 @@ func schema_openshift_api_config_v1_BuildOverrides(ref common.ReferenceCallback) Properties: map[string]spec.Schema{ "imageLabels": { SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -9799,7 +9800,7 @@ func schema_openshift_api_config_v1_BuildOverrides(ref common.ReferenceCallback) }, "nodeSelector": { SchemaProps: spec.SchemaProps{ - Description: "NodeSelector is a selector which must be true for the build pod to fit on a node", + Description: "nodeSelector is a selector which must be true for the build pod to fit on a node", Type: []string{"object"}, AdditionalProperties: &spec.SchemaOrBool{ Allows: true, @@ -9850,21 +9851,21 @@ func schema_openshift_api_config_v1_BuildSpec(ref common.ReferenceCallback) comm Properties: map[string]spec.Schema{ "additionalTrustedCA": { SchemaProps: spec.SchemaProps{ - 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.", + 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: map[string]interface{}{}, Ref: ref("github.com/openshift/api/config/v1.ConfigMapNameReference"), }, }, "buildDefaults": { SchemaProps: spec.SchemaProps{ - Description: "BuildDefaults controls the default information for Builds", + Description: "buildDefaults controls the default information for Builds", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/config/v1.BuildDefaults"), }, }, "buildOverrides": { SchemaProps: spec.SchemaProps{ - Description: "BuildOverrides controls override settings for builds", + Description: "buildOverrides controls override settings for builds", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/config/v1.BuildOverrides"), }, @@ -9886,7 +9887,7 @@ func schema_openshift_api_config_v1_CertInfo(ref common.ReferenceCallback) commo Properties: map[string]spec.Schema{ "certFile": { SchemaProps: spec.SchemaProps{ - Description: "CertFile is a file containing a PEM-encoded certificate", + Description: "certFile is a file containing a PEM-encoded certificate", Default: "", Type: []string{"string"}, Format: "", @@ -9894,7 +9895,7 @@ func schema_openshift_api_config_v1_CertInfo(ref common.ReferenceCallback) commo }, "keyFile": { SchemaProps: spec.SchemaProps{ - Description: "KeyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile", + Description: "keyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile", Default: "", Type: []string{"string"}, Format: "", @@ -10104,7 +10105,7 @@ func schema_openshift_api_config_v1_ClusterCondition(ref common.ReferenceCallbac }, "promql": { SchemaProps: spec.SchemaProps{ - Description: "promQL represents a cluster condition based on PromQL.", + Description: "promql represents a cluster condition based on PromQL.", Ref: ref("github.com/openshift/api/config/v1.PromQLClusterCondition"), }, }, @@ -11150,7 +11151,7 @@ func schema_openshift_api_config_v1_ConfigMapFileReference(ref common.ReferenceC }, "key": { SchemaProps: spec.SchemaProps{ - Description: "Key allows pointing to a specific key/value inside of the configmap. This is useful for logical file references.", + Description: "key allows pointing to a specific key/value inside of the configmap. This is useful for logical file references.", Type: []string{"string"}, Format: "", }, @@ -11796,7 +11797,7 @@ func schema_openshift_api_config_v1_EtcdConnectionInfo(ref common.ReferenceCallb }, "certFile": { SchemaProps: spec.SchemaProps{ - Description: "CertFile is a file containing a PEM-encoded certificate", + Description: "certFile is a file containing a PEM-encoded certificate", Default: "", Type: []string{"string"}, Format: "", @@ -11804,7 +11805,7 @@ func schema_openshift_api_config_v1_EtcdConnectionInfo(ref common.ReferenceCallb }, "keyFile": { SchemaProps: spec.SchemaProps{ - Description: "KeyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile", + Description: "keyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile", Default: "", Type: []string{"string"}, Format: "", @@ -11848,7 +11849,7 @@ func schema_openshift_api_config_v1_EtcdStorageConfig(ref common.ReferenceCallba }, "certFile": { SchemaProps: spec.SchemaProps{ - Description: "CertFile is a file containing a PEM-encoded certificate", + Description: "certFile is a file containing a PEM-encoded certificate", Default: "", Type: []string{"string"}, Format: "", @@ -11856,7 +11857,7 @@ func schema_openshift_api_config_v1_EtcdStorageConfig(ref common.ReferenceCallba }, "keyFile": { SchemaProps: spec.SchemaProps{ - Description: "KeyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile", + Description: "keyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile", Default: "", Type: []string{"string"}, Format: "", @@ -11980,7 +11981,7 @@ func schema_openshift_api_config_v1_ExternalPlatformSpec(ref common.ReferenceCal Properties: map[string]spec.Schema{ "platformName": { SchemaProps: spec.SchemaProps{ - 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.", + 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.", Default: "Unknown", Type: []string{"string"}, Format: "", @@ -12332,7 +12333,7 @@ func schema_openshift_api_config_v1_FeatureGateTests(ref common.ReferenceCallbac Properties: map[string]spec.Schema{ "featureGate": { SchemaProps: spec.SchemaProps{ - Description: "FeatureGate is the name of the FeatureGate as it appears in The FeatureGate CR instance.", + Description: "featureGate is the name of the FeatureGate as it appears in The FeatureGate CR instance.", Default: "", Type: []string{"string"}, Format: "", @@ -12340,7 +12341,7 @@ func schema_openshift_api_config_v1_FeatureGateTests(ref common.ReferenceCallbac }, "tests": { SchemaProps: spec.SchemaProps{ - Description: "Tests contains an item for every TestName", + Description: "tests contains an item for every TestName", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -12825,7 +12826,7 @@ func schema_openshift_api_config_v1_HTTPServingInfo(ref common.ReferenceCallback Properties: map[string]spec.Schema{ "bindAddress": { SchemaProps: spec.SchemaProps{ - Description: "BindAddress is the ip:port to serve on", + Description: "bindAddress is the ip:port to serve on", Default: "", Type: []string{"string"}, Format: "", @@ -12833,7 +12834,7 @@ func schema_openshift_api_config_v1_HTTPServingInfo(ref common.ReferenceCallback }, "bindNetwork": { SchemaProps: spec.SchemaProps{ - Description: "BindNetwork is the type of network to bind to - defaults to \"tcp4\", accepts \"tcp\", \"tcp4\", and \"tcp6\"", + Description: "bindNetwork is the type of network to bind to - defaults to \"tcp4\", accepts \"tcp\", \"tcp4\", and \"tcp6\"", Default: "", Type: []string{"string"}, Format: "", @@ -12841,7 +12842,7 @@ func schema_openshift_api_config_v1_HTTPServingInfo(ref common.ReferenceCallback }, "certFile": { SchemaProps: spec.SchemaProps{ - Description: "CertFile is a file containing a PEM-encoded certificate", + Description: "certFile is a file containing a PEM-encoded certificate", Default: "", Type: []string{"string"}, Format: "", @@ -12849,7 +12850,7 @@ func schema_openshift_api_config_v1_HTTPServingInfo(ref common.ReferenceCallback }, "keyFile": { SchemaProps: spec.SchemaProps{ - Description: "KeyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile", + Description: "keyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile", Default: "", Type: []string{"string"}, Format: "", @@ -12857,14 +12858,14 @@ func schema_openshift_api_config_v1_HTTPServingInfo(ref common.ReferenceCallback }, "clientCA": { SchemaProps: spec.SchemaProps{ - Description: "ClientCA is the certificate bundle for all the signers that you'll recognize for incoming client certificates", + Description: "clientCA is the certificate bundle for all the signers that you'll recognize for incoming client certificates", Type: []string{"string"}, Format: "", }, }, "namedCertificates": { SchemaProps: spec.SchemaProps{ - Description: "NamedCertificates is a list of certificates to use to secure requests to specific hostnames", + Description: "namedCertificates is a list of certificates to use to secure requests to specific hostnames", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -12878,14 +12879,14 @@ func schema_openshift_api_config_v1_HTTPServingInfo(ref common.ReferenceCallback }, "minTLSVersion": { SchemaProps: spec.SchemaProps{ - Description: "MinTLSVersion is the minimum TLS version supported. Values must match version names from https://golang.org/pkg/crypto/tls/#pkg-constants", + Description: "minTLSVersion is the minimum TLS version supported. Values must match version names from https://golang.org/pkg/crypto/tls/#pkg-constants", Type: []string{"string"}, Format: "", }, }, "cipherSuites": { SchemaProps: spec.SchemaProps{ - 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", + 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: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -12900,7 +12901,7 @@ func schema_openshift_api_config_v1_HTTPServingInfo(ref common.ReferenceCallback }, "maxRequestsInFlight": { SchemaProps: spec.SchemaProps{ - Description: "MaxRequestsInFlight is the number of concurrent requests allowed to the server. If zero, no limit.", + Description: "maxRequestsInFlight is the number of concurrent requests allowed to the server. If zero, no limit.", Default: 0, Type: []string{"integer"}, Format: "int64", @@ -12908,7 +12909,7 @@ func schema_openshift_api_config_v1_HTTPServingInfo(ref common.ReferenceCallback }, "requestTimeoutSeconds": { SchemaProps: spec.SchemaProps{ - 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.", + 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.", Default: 0, Type: []string{"integer"}, Format: "int64", @@ -13000,35 +13001,35 @@ func schema_openshift_api_config_v1_IBMCloudPlatformStatus(ref common.ReferenceC Properties: map[string]spec.Schema{ "location": { SchemaProps: spec.SchemaProps{ - Description: "Location is where the cluster has been deployed", + Description: "location is where the cluster has been deployed", Type: []string{"string"}, Format: "", }, }, "resourceGroupName": { SchemaProps: spec.SchemaProps{ - Description: "ResourceGroupName is the Resource Group for new IBMCloud resources created for the cluster.", + Description: "resourceGroupName is the Resource Group for new IBMCloud resources created for the cluster.", Type: []string{"string"}, Format: "", }, }, "providerType": { SchemaProps: spec.SchemaProps{ - Description: "ProviderType indicates the type of cluster that was created", + Description: "providerType indicates the type of cluster that was created", Type: []string{"string"}, Format: "", }, }, "cisInstanceCRN": { SchemaProps: spec.SchemaProps{ - Description: "CISInstanceCRN is the CRN of the Cloud Internet Services instance managing the DNS zone for the cluster's base domain", + Description: "cisInstanceCRN is the CRN of the Cloud Internet Services instance managing the DNS zone for the cluster's base domain", Type: []string{"string"}, Format: "", }, }, "dnsInstanceCRN": { SchemaProps: spec.SchemaProps{ - Description: "DNSInstanceCRN is the CRN of the DNS Services instance managing the DNS zone for the cluster's base domain", + Description: "dnsInstanceCRN is the CRN of the DNS Services instance managing the DNS zone for the cluster's base domain", Type: []string{"string"}, Format: "", }, @@ -13648,7 +13649,7 @@ func schema_openshift_api_config_v1_ImageLabel(ref common.ReferenceCallback) com Properties: map[string]spec.Schema{ "name": { SchemaProps: spec.SchemaProps{ - Description: "Name defines the name of the label. It must have non-zero length.", + Description: "name defines the name of the label. It must have non-zero length.", Default: "", Type: []string{"string"}, Format: "", @@ -13656,7 +13657,7 @@ func schema_openshift_api_config_v1_ImageLabel(ref common.ReferenceCallback) com }, "value": { SchemaProps: spec.SchemaProps{ - Description: "Value defines the literal value of the label.", + Description: "value defines the literal value of the label.", Type: []string{"string"}, Format: "", }, @@ -14864,13 +14865,13 @@ func schema_openshift_api_config_v1_MTUMigration(ref common.ReferenceCallback) c Properties: map[string]spec.Schema{ "network": { SchemaProps: spec.SchemaProps{ - Description: "Network contains MTU migration configuration for the default network.", + Description: "network contains MTU migration configuration for the default network.", Ref: ref("github.com/openshift/api/config/v1.MTUMigrationValues"), }, }, "machine": { SchemaProps: spec.SchemaProps{ - Description: "Machine contains MTU migration configuration for the machine's uplink.", + Description: "machine contains MTU migration configuration for the machine's uplink.", Ref: ref("github.com/openshift/api/config/v1.MTUMigrationValues"), }, }, @@ -14957,7 +14958,7 @@ func schema_openshift_api_config_v1_NamedCertificate(ref common.ReferenceCallbac Properties: map[string]spec.Schema{ "names": { SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -14972,7 +14973,7 @@ func schema_openshift_api_config_v1_NamedCertificate(ref common.ReferenceCallbac }, "certFile": { SchemaProps: spec.SchemaProps{ - Description: "CertFile is a file containing a PEM-encoded certificate", + Description: "certFile is a file containing a PEM-encoded certificate", Default: "", Type: []string{"string"}, Format: "", @@ -14980,7 +14981,7 @@ func schema_openshift_api_config_v1_NamedCertificate(ref common.ReferenceCallbac }, "keyFile": { SchemaProps: spec.SchemaProps{ - Description: "KeyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile", + Description: "keyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile", Default: "", Type: []string{"string"}, Format: "", @@ -15239,14 +15240,14 @@ func schema_openshift_api_config_v1_NetworkMigration(ref common.ReferenceCallbac Properties: map[string]spec.Schema{ "networkType": { SchemaProps: spec.SchemaProps{ - Description: "NetworkType is the target plugin that is being deployed. DEPRECATED: network type migration is no longer supported, so this should always be unset.", + 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{"string"}, Format: "", }, }, "mtu": { SchemaProps: spec.SchemaProps{ - Description: "MTU is the MTU configuration that is being deployed.", + Description: "mtu is the MTU configuration that is being deployed.", Ref: ref("github.com/openshift/api/config/v1.MTUMigration"), }, }, @@ -15306,7 +15307,7 @@ func schema_openshift_api_config_v1_NetworkSpec(ref common.ReferenceCallback) co }, "networkType": { SchemaProps: spec.SchemaProps{ - 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.", + 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.", Default: "", Type: []string{"string"}, Format: "", @@ -15389,21 +15390,21 @@ func schema_openshift_api_config_v1_NetworkStatus(ref common.ReferenceCallback) }, "networkType": { SchemaProps: spec.SchemaProps{ - Description: "NetworkType is the plugin that is deployed (e.g. OVNKubernetes).", + Description: "networkType is the plugin that is deployed (e.g. OVNKubernetes).", Type: []string{"string"}, Format: "", }, }, "clusterNetworkMTU": { SchemaProps: spec.SchemaProps{ - Description: "ClusterNetworkMTU is the MTU for inter-pod networking.", + Description: "clusterNetworkMTU is the MTU for inter-pod networking.", Type: []string{"integer"}, Format: "int32", }, }, "migration": { SchemaProps: spec.SchemaProps{ - Description: "Migration contains the cluster network migration configuration.", + Description: "migration contains the cluster network migration configuration.", Ref: ref("github.com/openshift/api/config/v1.NetworkMigration"), }, }, @@ -15548,14 +15549,14 @@ func schema_openshift_api_config_v1_NodeSpec(ref common.ReferenceCallback) commo Properties: map[string]spec.Schema{ "cgroupMode": { SchemaProps: spec.SchemaProps{ - Description: "CgroupMode determines the cgroups version on the node", + Description: "cgroupMode determines the cgroups version on the node", Type: []string{"string"}, Format: "", }, }, "workerLatencyProfile": { SchemaProps: spec.SchemaProps{ - Description: "WorkerLatencyProfile determins the how fast the kubelet is updating the status and corresponding reaction of the cluster", + Description: "workerLatencyProfile determins the how fast the kubelet is updating the status and corresponding reaction of the cluster", Type: []string{"string"}, Format: "", }, @@ -16197,7 +16198,7 @@ func schema_openshift_api_config_v1_OIDCClientConfig(ref common.ReferenceCallbac Properties: map[string]spec.Schema{ "componentName": { SchemaProps: spec.SchemaProps{ - Description: "ComponentName is the name of the component that is supposed to consume this client configuration", + Description: "componentName is the name of the component that is supposed to consume this client configuration", Default: "", Type: []string{"string"}, Format: "", @@ -16205,7 +16206,7 @@ func schema_openshift_api_config_v1_OIDCClientConfig(ref common.ReferenceCallbac }, "componentNamespace": { SchemaProps: spec.SchemaProps{ - Description: "ComponentNamespace is the namespace of the component that is supposed to consume this client configuration", + Description: "componentNamespace is the namespace of the component that is supposed to consume this client configuration", Default: "", Type: []string{"string"}, Format: "", @@ -16213,7 +16214,7 @@ func schema_openshift_api_config_v1_OIDCClientConfig(ref common.ReferenceCallbac }, "clientID": { SchemaProps: spec.SchemaProps{ - Description: "ClientID is the identifier of the OIDC client from the OIDC provider", + Description: "clientID is the identifier of the OIDC client from the OIDC provider", Default: "", Type: []string{"string"}, Format: "", @@ -16221,7 +16222,7 @@ func schema_openshift_api_config_v1_OIDCClientConfig(ref common.ReferenceCallbac }, "clientSecret": { SchemaProps: spec.SchemaProps{ - Description: "ClientSecret refers to a secret in the `openshift-config` namespace that contains the client secret in the `clientSecret` key of the `.data` field", + Description: "clientSecret refers to a secret in the `openshift-config` namespace that contains the client secret in the `clientSecret` key of the `.data` field", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/config/v1.SecretNameReference"), }, @@ -16233,7 +16234,7 @@ func schema_openshift_api_config_v1_OIDCClientConfig(ref common.ReferenceCallbac }, }, SchemaProps: spec.SchemaProps{ - Description: "ExtraScopes is an optional set of scopes to request tokens with.", + Description: "extraScopes is an optional set of scopes to request tokens with.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -16279,7 +16280,7 @@ func schema_openshift_api_config_v1_OIDCClientReference(ref common.ReferenceCall }, "clientID": { SchemaProps: spec.SchemaProps{ - Description: "ClientID is the identifier of the OIDC client from the OIDC provider", + Description: "clientID is the identifier of the OIDC client from the OIDC provider", Default: "", Type: []string{"string"}, Format: "", @@ -16300,7 +16301,7 @@ func schema_openshift_api_config_v1_OIDCClientStatus(ref common.ReferenceCallbac Properties: map[string]spec.Schema{ "componentName": { SchemaProps: spec.SchemaProps{ - Description: "ComponentName is the name of the component that will consume a client configuration.", + Description: "componentName is the name of the component that will consume a client configuration.", Default: "", Type: []string{"string"}, Format: "", @@ -16308,7 +16309,7 @@ func schema_openshift_api_config_v1_OIDCClientStatus(ref common.ReferenceCallbac }, "componentNamespace": { SchemaProps: spec.SchemaProps{ - Description: "ComponentNamespace is the namespace of the component that will consume a client configuration.", + Description: "componentNamespace is the namespace of the component that will consume a client configuration.", Default: "", Type: []string{"string"}, Format: "", @@ -16325,7 +16326,7 @@ func schema_openshift_api_config_v1_OIDCClientStatus(ref common.ReferenceCallbac }, }, SchemaProps: spec.SchemaProps{ - Description: "CurrentOIDCClients is a list of clients that the component is currently using.", + Description: "currentOIDCClients is a list of clients that the component is currently using.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -16344,7 +16345,7 @@ func schema_openshift_api_config_v1_OIDCClientStatus(ref common.ReferenceCallbac }, }, SchemaProps: spec.SchemaProps{ - Description: "ConsumingUsers is a slice of ServiceAccounts that need to have read permission on the `clientSecret` secret.", + Description: "consumingUsers is a slice of ServiceAccounts that need to have read permission on the `clientSecret` secret.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -16367,7 +16368,7 @@ func schema_openshift_api_config_v1_OIDCClientStatus(ref common.ReferenceCallbac }, }, SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -16396,7 +16397,7 @@ func schema_openshift_api_config_v1_OIDCProvider(ref common.ReferenceCallback) c Properties: map[string]spec.Schema{ "name": { SchemaProps: spec.SchemaProps{ - Description: "Name of the OIDC provider", + Description: "name of the OIDC provider", Default: "", Type: []string{"string"}, Format: "", @@ -16404,7 +16405,7 @@ func schema_openshift_api_config_v1_OIDCProvider(ref common.ReferenceCallback) c }, "issuer": { SchemaProps: spec.SchemaProps{ - Description: "Issuer describes atributes of the OIDC token issuer", + Description: "issuer describes atributes of the OIDC token issuer", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/config/v1.TokenIssuer"), }, @@ -16420,7 +16421,7 @@ func schema_openshift_api_config_v1_OIDCProvider(ref common.ReferenceCallback) c }, }, SchemaProps: spec.SchemaProps{ - Description: "OIDCClients contains configuration for the platform's clients that need to request tokens from the issuer", + Description: "oidcClients contains configuration for the platform's clients that need to request tokens from the issuer", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -16434,7 +16435,7 @@ func schema_openshift_api_config_v1_OIDCProvider(ref common.ReferenceCallback) c }, "claimMappings": { SchemaProps: spec.SchemaProps{ - Description: "ClaimMappings describes rules on how to transform information from an ID token into a cluster identity", + Description: "claimMappings describes rules on how to transform information from an ID token into a cluster identity", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/config/v1.TokenClaimMappings"), }, @@ -16446,7 +16447,7 @@ func schema_openshift_api_config_v1_OIDCProvider(ref common.ReferenceCallback) c }, }, SchemaProps: spec.SchemaProps{ - Description: "ClaimValidationRules are rules that are applied to validate token claims to authenticate users.", + Description: "claimValidationRules are rules that are applied to validate token claims to authenticate users.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -17251,79 +17252,79 @@ func schema_openshift_api_config_v1_PlatformSpec(ref common.ReferenceCallback) c }, "aws": { SchemaProps: spec.SchemaProps{ - Description: "AWS contains settings specific to the Amazon Web Services infrastructure provider.", + Description: "aws contains settings specific to the Amazon Web Services infrastructure provider.", Ref: ref("github.com/openshift/api/config/v1.AWSPlatformSpec"), }, }, "azure": { SchemaProps: spec.SchemaProps{ - Description: "Azure contains settings specific to the Azure infrastructure provider.", + Description: "azure contains settings specific to the Azure infrastructure provider.", Ref: ref("github.com/openshift/api/config/v1.AzurePlatformSpec"), }, }, "gcp": { SchemaProps: spec.SchemaProps{ - Description: "GCP contains settings specific to the Google Cloud Platform infrastructure provider.", + Description: "gcp contains settings specific to the Google Cloud Platform infrastructure provider.", Ref: ref("github.com/openshift/api/config/v1.GCPPlatformSpec"), }, }, "baremetal": { SchemaProps: spec.SchemaProps{ - Description: "BareMetal contains settings specific to the BareMetal platform.", + Description: "baremetal contains settings specific to the BareMetal platform.", Ref: ref("github.com/openshift/api/config/v1.BareMetalPlatformSpec"), }, }, "openstack": { SchemaProps: spec.SchemaProps{ - Description: "OpenStack contains settings specific to the OpenStack infrastructure provider.", + Description: "openstack contains settings specific to the OpenStack infrastructure provider.", Ref: ref("github.com/openshift/api/config/v1.OpenStackPlatformSpec"), }, }, "ovirt": { SchemaProps: spec.SchemaProps{ - Description: "Ovirt contains settings specific to the oVirt infrastructure provider.", + Description: "ovirt contains settings specific to the oVirt infrastructure provider.", Ref: ref("github.com/openshift/api/config/v1.OvirtPlatformSpec"), }, }, "vsphere": { SchemaProps: spec.SchemaProps{ - Description: "VSphere contains settings specific to the VSphere infrastructure provider.", + Description: "vsphere contains settings specific to the VSphere infrastructure provider.", Ref: ref("github.com/openshift/api/config/v1.VSpherePlatformSpec"), }, }, "ibmcloud": { SchemaProps: spec.SchemaProps{ - Description: "IBMCloud contains settings specific to the IBMCloud infrastructure provider.", + Description: "ibmcloud contains settings specific to the IBMCloud infrastructure provider.", Ref: ref("github.com/openshift/api/config/v1.IBMCloudPlatformSpec"), }, }, "kubevirt": { SchemaProps: spec.SchemaProps{ - Description: "Kubevirt contains settings specific to the kubevirt infrastructure provider.", + Description: "kubevirt contains settings specific to the kubevirt infrastructure provider.", Ref: ref("github.com/openshift/api/config/v1.KubevirtPlatformSpec"), }, }, "equinixMetal": { SchemaProps: spec.SchemaProps{ - Description: "EquinixMetal contains settings specific to the Equinix Metal infrastructure provider.", + Description: "equinixMetal contains settings specific to the Equinix Metal infrastructure provider.", Ref: ref("github.com/openshift/api/config/v1.EquinixMetalPlatformSpec"), }, }, "powervs": { SchemaProps: spec.SchemaProps{ - Description: "PowerVS contains settings specific to the IBM Power Systems Virtual Servers infrastructure provider.", + Description: "powervs contains settings specific to the IBM Power Systems Virtual Servers infrastructure provider.", Ref: ref("github.com/openshift/api/config/v1.PowerVSPlatformSpec"), }, }, "alibabaCloud": { SchemaProps: spec.SchemaProps{ - Description: "AlibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider.", + Description: "alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider.", Ref: ref("github.com/openshift/api/config/v1.AlibabaCloudPlatformSpec"), }, }, "nutanix": { SchemaProps: spec.SchemaProps{ - Description: "Nutanix contains settings specific to the Nutanix infrastructure provider.", + Description: "nutanix contains settings specific to the Nutanix infrastructure provider.", Ref: ref("github.com/openshift/api/config/v1.NutanixPlatformSpec"), }, }, @@ -17359,85 +17360,85 @@ func schema_openshift_api_config_v1_PlatformStatus(ref common.ReferenceCallback) }, "aws": { SchemaProps: spec.SchemaProps{ - Description: "AWS contains settings specific to the Amazon Web Services infrastructure provider.", + Description: "aws contains settings specific to the Amazon Web Services infrastructure provider.", Ref: ref("github.com/openshift/api/config/v1.AWSPlatformStatus"), }, }, "azure": { SchemaProps: spec.SchemaProps{ - Description: "Azure contains settings specific to the Azure infrastructure provider.", + Description: "azure contains settings specific to the Azure infrastructure provider.", Ref: ref("github.com/openshift/api/config/v1.AzurePlatformStatus"), }, }, "gcp": { SchemaProps: spec.SchemaProps{ - Description: "GCP contains settings specific to the Google Cloud Platform infrastructure provider.", + Description: "gcp contains settings specific to the Google Cloud Platform infrastructure provider.", Ref: ref("github.com/openshift/api/config/v1.GCPPlatformStatus"), }, }, "baremetal": { SchemaProps: spec.SchemaProps{ - Description: "BareMetal contains settings specific to the BareMetal platform.", + Description: "baremetal contains settings specific to the BareMetal platform.", Ref: ref("github.com/openshift/api/config/v1.BareMetalPlatformStatus"), }, }, "openstack": { SchemaProps: spec.SchemaProps{ - Description: "OpenStack contains settings specific to the OpenStack infrastructure provider.", + Description: "openstack contains settings specific to the OpenStack infrastructure provider.", Ref: ref("github.com/openshift/api/config/v1.OpenStackPlatformStatus"), }, }, "ovirt": { SchemaProps: spec.SchemaProps{ - Description: "Ovirt contains settings specific to the oVirt infrastructure provider.", + Description: "ovirt contains settings specific to the oVirt infrastructure provider.", Ref: ref("github.com/openshift/api/config/v1.OvirtPlatformStatus"), }, }, "vsphere": { SchemaProps: spec.SchemaProps{ - Description: "VSphere contains settings specific to the VSphere infrastructure provider.", + Description: "vsphere contains settings specific to the VSphere infrastructure provider.", Ref: ref("github.com/openshift/api/config/v1.VSpherePlatformStatus"), }, }, "ibmcloud": { SchemaProps: spec.SchemaProps{ - Description: "IBMCloud contains settings specific to the IBMCloud infrastructure provider.", + Description: "ibmcloud contains settings specific to the IBMCloud infrastructure provider.", Ref: ref("github.com/openshift/api/config/v1.IBMCloudPlatformStatus"), }, }, "kubevirt": { SchemaProps: spec.SchemaProps{ - Description: "Kubevirt contains settings specific to the kubevirt infrastructure provider.", + Description: "kubevirt contains settings specific to the kubevirt infrastructure provider.", Ref: ref("github.com/openshift/api/config/v1.KubevirtPlatformStatus"), }, }, "equinixMetal": { SchemaProps: spec.SchemaProps{ - Description: "EquinixMetal contains settings specific to the Equinix Metal infrastructure provider.", + Description: "equinixMetal contains settings specific to the Equinix Metal infrastructure provider.", Ref: ref("github.com/openshift/api/config/v1.EquinixMetalPlatformStatus"), }, }, "powervs": { SchemaProps: spec.SchemaProps{ - Description: "PowerVS contains settings specific to the Power Systems Virtual Servers infrastructure provider.", + Description: "powervs contains settings specific to the Power Systems Virtual Servers infrastructure provider.", Ref: ref("github.com/openshift/api/config/v1.PowerVSPlatformStatus"), }, }, "alibabaCloud": { SchemaProps: spec.SchemaProps{ - Description: "AlibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider.", + Description: "alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider.", Ref: ref("github.com/openshift/api/config/v1.AlibabaCloudPlatformStatus"), }, }, "nutanix": { SchemaProps: spec.SchemaProps{ - Description: "Nutanix contains settings specific to the Nutanix infrastructure provider.", + Description: "nutanix contains settings specific to the Nutanix infrastructure provider.", Ref: ref("github.com/openshift/api/config/v1.NutanixPlatformStatus"), }, }, "external": { SchemaProps: spec.SchemaProps{ - Description: "External contains settings specific to the generic External infrastructure provider.", + Description: "external contains settings specific to the generic External infrastructure provider.", Ref: ref("github.com/openshift/api/config/v1.ExternalPlatformStatus"), }, }, @@ -17542,14 +17543,14 @@ func schema_openshift_api_config_v1_PowerVSPlatformStatus(ref common.ReferenceCa }, "cisInstanceCRN": { SchemaProps: spec.SchemaProps{ - Description: "CISInstanceCRN is the CRN of the Cloud Internet Services instance managing the DNS zone for the cluster's base domain", + Description: "cisInstanceCRN is the CRN of the Cloud Internet Services instance managing the DNS zone for the cluster's base domain", Type: []string{"string"}, Format: "", }, }, "dnsInstanceCRN": { SchemaProps: spec.SchemaProps{ - Description: "DNSInstanceCRN is the CRN of the DNS Services instance managing the DNS zone for the cluster's base domain", + Description: "dnsInstanceCRN is the CRN of the DNS Services instance managing the DNS zone for the cluster's base domain", Type: []string{"string"}, Format: "", }, @@ -17601,7 +17602,7 @@ func schema_openshift_api_config_v1_PrefixedClaimMapping(ref common.ReferenceCal Properties: map[string]spec.Schema{ "claim": { SchemaProps: spec.SchemaProps{ - Description: "Claim is a JWT token claim to be used in the mapping", + Description: "claim is a JWT token claim to be used in the mapping", Default: "", Type: []string{"string"}, Format: "", @@ -17609,7 +17610,7 @@ func schema_openshift_api_config_v1_PrefixedClaimMapping(ref common.ReferenceCal }, "prefix": { SchemaProps: spec.SchemaProps{ - Description: "Prefix is a string to prefix the value from the token in the result of the claim mapping.\n\nBy default, no prefixing occurs.\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\".", + Description: "prefix is a string to prefix the value from the token in the result of the claim mapping.\n\nBy default, no prefixing occurs.\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\".", Default: "", Type: []string{"string"}, Format: "", @@ -17793,7 +17794,7 @@ func schema_openshift_api_config_v1_PromQLClusterCondition(ref common.ReferenceC Properties: map[string]spec.Schema{ "promql": { SchemaProps: spec.SchemaProps{ - 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.", + 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.", Default: "", Type: []string{"string"}, Format: "", @@ -17836,7 +17837,7 @@ func schema_openshift_api_config_v1_Proxy(ref common.ReferenceCallback) common.O }, "spec": { SchemaProps: spec.SchemaProps{ - Description: "Spec holds user-settable values for the proxy configuration", + Description: "spec holds user-settable values for the proxy configuration", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/config/v1.ProxySpec"), }, @@ -18194,7 +18195,7 @@ func schema_openshift_api_config_v1_RemoteConnectionInfo(ref common.ReferenceCal Properties: map[string]spec.Schema{ "url": { SchemaProps: spec.SchemaProps{ - Description: "URL is the remote URL to connect to", + Description: "url is the remote URL to connect to", Default: "", Type: []string{"string"}, Format: "", @@ -18202,7 +18203,7 @@ func schema_openshift_api_config_v1_RemoteConnectionInfo(ref common.ReferenceCal }, "ca": { SchemaProps: spec.SchemaProps{ - Description: "CA is the CA for verifying TLS connections", + Description: "ca is the CA for verifying TLS connections", Default: "", Type: []string{"string"}, Format: "", @@ -18210,7 +18211,7 @@ func schema_openshift_api_config_v1_RemoteConnectionInfo(ref common.ReferenceCal }, "certFile": { SchemaProps: spec.SchemaProps{ - Description: "CertFile is a file containing a PEM-encoded certificate", + Description: "certFile is a file containing a PEM-encoded certificate", Default: "", Type: []string{"string"}, Format: "", @@ -18218,7 +18219,7 @@ func schema_openshift_api_config_v1_RemoteConnectionInfo(ref common.ReferenceCal }, "keyFile": { SchemaProps: spec.SchemaProps{ - Description: "KeyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile", + Description: "keyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile", Default: "", Type: []string{"string"}, Format: "", @@ -18588,7 +18589,7 @@ func schema_openshift_api_config_v1_SchedulerSpec(ref common.ReferenceCallback) }, "mastersSchedulable": { SchemaProps: spec.SchemaProps{ - 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.", + 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.", Default: false, Type: []string{"boolean"}, Format: "", @@ -18643,7 +18644,7 @@ func schema_openshift_api_config_v1_ServingInfo(ref common.ReferenceCallback) co Properties: map[string]spec.Schema{ "bindAddress": { SchemaProps: spec.SchemaProps{ - Description: "BindAddress is the ip:port to serve on", + Description: "bindAddress is the ip:port to serve on", Default: "", Type: []string{"string"}, Format: "", @@ -18651,7 +18652,7 @@ func schema_openshift_api_config_v1_ServingInfo(ref common.ReferenceCallback) co }, "bindNetwork": { SchemaProps: spec.SchemaProps{ - Description: "BindNetwork is the type of network to bind to - defaults to \"tcp4\", accepts \"tcp\", \"tcp4\", and \"tcp6\"", + Description: "bindNetwork is the type of network to bind to - defaults to \"tcp4\", accepts \"tcp\", \"tcp4\", and \"tcp6\"", Default: "", Type: []string{"string"}, Format: "", @@ -18659,7 +18660,7 @@ func schema_openshift_api_config_v1_ServingInfo(ref common.ReferenceCallback) co }, "certFile": { SchemaProps: spec.SchemaProps{ - Description: "CertFile is a file containing a PEM-encoded certificate", + Description: "certFile is a file containing a PEM-encoded certificate", Default: "", Type: []string{"string"}, Format: "", @@ -18667,7 +18668,7 @@ func schema_openshift_api_config_v1_ServingInfo(ref common.ReferenceCallback) co }, "keyFile": { SchemaProps: spec.SchemaProps{ - Description: "KeyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile", + Description: "keyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile", Default: "", Type: []string{"string"}, Format: "", @@ -18675,14 +18676,14 @@ func schema_openshift_api_config_v1_ServingInfo(ref common.ReferenceCallback) co }, "clientCA": { SchemaProps: spec.SchemaProps{ - Description: "ClientCA is the certificate bundle for all the signers that you'll recognize for incoming client certificates", + Description: "clientCA is the certificate bundle for all the signers that you'll recognize for incoming client certificates", Type: []string{"string"}, Format: "", }, }, "namedCertificates": { SchemaProps: spec.SchemaProps{ - Description: "NamedCertificates is a list of certificates to use to secure requests to specific hostnames", + Description: "namedCertificates is a list of certificates to use to secure requests to specific hostnames", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -18696,14 +18697,14 @@ func schema_openshift_api_config_v1_ServingInfo(ref common.ReferenceCallback) co }, "minTLSVersion": { SchemaProps: spec.SchemaProps{ - Description: "MinTLSVersion is the minimum TLS version supported. Values must match version names from https://golang.org/pkg/crypto/tls/#pkg-constants", + Description: "minTLSVersion is the minimum TLS version supported. Values must match version names from https://golang.org/pkg/crypto/tls/#pkg-constants", Type: []string{"string"}, Format: "", }, }, "cipherSuites": { SchemaProps: spec.SchemaProps{ - 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", + 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: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -18765,7 +18766,7 @@ func schema_openshift_api_config_v1_StringSource(ref common.ReferenceCallback) c Properties: map[string]spec.Schema{ "value": { SchemaProps: spec.SchemaProps{ - Description: "Value specifies the cleartext value, or an encrypted value if keyFile is specified.", + Description: "value specifies the cleartext value, or an encrypted value if keyFile is specified.", Default: "", Type: []string{"string"}, Format: "", @@ -18773,7 +18774,7 @@ func schema_openshift_api_config_v1_StringSource(ref common.ReferenceCallback) c }, "env": { SchemaProps: spec.SchemaProps{ - Description: "Env specifies an envvar containing the cleartext value, or an encrypted value if the keyFile is specified.", + Description: "env specifies an envvar containing the cleartext value, or an encrypted value if the keyFile is specified.", Default: "", Type: []string{"string"}, Format: "", @@ -18781,7 +18782,7 @@ func schema_openshift_api_config_v1_StringSource(ref common.ReferenceCallback) c }, "file": { SchemaProps: spec.SchemaProps{ - Description: "File references a file containing the cleartext value, or an encrypted value if a keyFile is specified.", + Description: "file references a file containing the cleartext value, or an encrypted value if a keyFile is specified.", Default: "", Type: []string{"string"}, Format: "", @@ -18789,7 +18790,7 @@ func schema_openshift_api_config_v1_StringSource(ref common.ReferenceCallback) c }, "keyFile": { SchemaProps: spec.SchemaProps{ - Description: "KeyFile references a file containing the key to use to decrypt the value.", + Description: "keyFile references a file containing the key to use to decrypt the value.", Default: "", Type: []string{"string"}, Format: "", @@ -18811,7 +18812,7 @@ func schema_openshift_api_config_v1_StringSourceSpec(ref common.ReferenceCallbac Properties: map[string]spec.Schema{ "value": { SchemaProps: spec.SchemaProps{ - Description: "Value specifies the cleartext value, or an encrypted value if keyFile is specified.", + Description: "value specifies the cleartext value, or an encrypted value if keyFile is specified.", Default: "", Type: []string{"string"}, Format: "", @@ -18819,7 +18820,7 @@ func schema_openshift_api_config_v1_StringSourceSpec(ref common.ReferenceCallbac }, "env": { SchemaProps: spec.SchemaProps{ - Description: "Env specifies an envvar containing the cleartext value, or an encrypted value if the keyFile is specified.", + Description: "env specifies an envvar containing the cleartext value, or an encrypted value if the keyFile is specified.", Default: "", Type: []string{"string"}, Format: "", @@ -18827,7 +18828,7 @@ func schema_openshift_api_config_v1_StringSourceSpec(ref common.ReferenceCallbac }, "file": { SchemaProps: spec.SchemaProps{ - Description: "File references a file containing the cleartext value, or an encrypted value if a keyFile is specified.", + Description: "file references a file containing the cleartext value, or an encrypted value if a keyFile is specified.", Default: "", Type: []string{"string"}, Format: "", @@ -18835,7 +18836,7 @@ func schema_openshift_api_config_v1_StringSourceSpec(ref common.ReferenceCallbac }, "keyFile": { SchemaProps: spec.SchemaProps{ - Description: "KeyFile references a file containing the key to use to decrypt the value.", + Description: "keyFile references a file containing the key to use to decrypt the value.", Default: "", Type: []string{"string"}, Format: "", @@ -18982,7 +18983,7 @@ func schema_openshift_api_config_v1_TestDetails(ref common.ReferenceCallback) co Properties: map[string]spec.Schema{ "testName": { SchemaProps: spec.SchemaProps{ - 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.", + 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.", Default: "", Type: []string{"string"}, Format: "", @@ -19053,7 +19054,7 @@ func schema_openshift_api_config_v1_TestReportingSpec(ref common.ReferenceCallba Properties: map[string]spec.Schema{ "testsForFeatureGates": { SchemaProps: spec.SchemaProps{ - Description: "TestsForFeatureGates is a list, indexed by FeatureGate and includes information about testing.", + Description: "testsForFeatureGates is a list, indexed by FeatureGate and includes information about testing.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -19092,7 +19093,7 @@ func schema_openshift_api_config_v1_TokenClaimMapping(ref common.ReferenceCallba Properties: map[string]spec.Schema{ "claim": { SchemaProps: spec.SchemaProps{ - Description: "Claim is a JWT token claim to be used in the mapping", + Description: "claim is a JWT token claim to be used in the mapping", Default: "", Type: []string{"string"}, Format: "", @@ -19113,14 +19114,14 @@ func schema_openshift_api_config_v1_TokenClaimMappings(ref common.ReferenceCallb Properties: map[string]spec.Schema{ "username": { SchemaProps: spec.SchemaProps{ - Description: "Username is a name of the claim that should be used to construct usernames for the cluster identity.\n\nDefault value: \"sub\"", + Description: "username is a name of the claim that should be used to construct usernames for the cluster identity.\n\nDefault value: \"sub\"", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/config/v1.UsernameClaimMapping"), }, }, "groups": { SchemaProps: spec.SchemaProps{ - Description: "Groups is a name of the claim that should be used to construct groups for the cluster identity. The referenced claim must use array of strings values.", + Description: "groups is a name of the claim that should be used to construct groups for the cluster identity. The referenced claim must use array of strings values.", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/config/v1.PrefixedClaimMapping"), }, @@ -19141,7 +19142,7 @@ func schema_openshift_api_config_v1_TokenClaimValidationRule(ref common.Referenc Properties: map[string]spec.Schema{ "type": { SchemaProps: spec.SchemaProps{ - Description: "Type sets the type of the validation rule", + Description: "type sets the type of the validation rule", Default: "", Type: []string{"string"}, Format: "", @@ -19149,7 +19150,7 @@ func schema_openshift_api_config_v1_TokenClaimValidationRule(ref common.Referenc }, "requiredClaim": { SchemaProps: spec.SchemaProps{ - Description: "RequiredClaim allows configuring a required claim name and its expected value", + Description: "requiredClaim allows configuring a required claim name and its expected value", Ref: ref("github.com/openshift/api/config/v1.TokenRequiredClaim"), }, }, @@ -19218,7 +19219,7 @@ func schema_openshift_api_config_v1_TokenIssuer(ref common.ReferenceCallback) co }, }, SchemaProps: spec.SchemaProps{ - Description: "Audiences is an array of audiences that the token was issued for. Valid tokens must include at least one of these values in their \"aud\" claim. Must be set to exactly one value.", + Description: "audiences is an array of audiences that the token was issued for. Valid tokens must include at least one of these values in their \"aud\" claim. Must be set to exactly one value.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -19255,7 +19256,7 @@ func schema_openshift_api_config_v1_TokenRequiredClaim(ref common.ReferenceCallb Properties: map[string]spec.Schema{ "claim": { SchemaProps: spec.SchemaProps{ - Description: "Claim is a name of a required claim. Only claims with string values are supported.", + Description: "claim is a name of a required claim. Only claims with string values are supported.", Default: "", Type: []string{"string"}, Format: "", @@ -19263,7 +19264,7 @@ func schema_openshift_api_config_v1_TokenRequiredClaim(ref common.ReferenceCallb }, "requiredValue": { SchemaProps: spec.SchemaProps{ - Description: "RequiredValue is the required value for the claim.", + Description: "requiredValue is the required value for the claim.", Default: "", Type: []string{"string"}, Format: "", @@ -19396,7 +19397,7 @@ func schema_openshift_api_config_v1_UsernameClaimMapping(ref common.ReferenceCal Properties: map[string]spec.Schema{ "claim": { SchemaProps: spec.SchemaProps{ - Description: "Claim is a JWT token claim to be used in the mapping", + Description: "claim is a JWT token claim to be used in the mapping", Default: "", Type: []string{"string"}, Format: "", @@ -19404,7 +19405,7 @@ func schema_openshift_api_config_v1_UsernameClaimMapping(ref common.ReferenceCal }, "prefixPolicy": { SchemaProps: spec.SchemaProps{ - Description: "PrefixPolicy specifies how a prefix should apply.\n\nBy default, claims other than `email` will be prefixed with the issuer URL to prevent naming clashes with other plugins.\n\nSet to \"NoPrefix\" to disable prefixing.\n\nExample:\n (1) `prefix` is set to \"myoidc:\" and `claim` is set to \"username\".\n If the JWT claim `username` contains value `userA`, the resulting\n mapped value will be \"myoidc:userA\".\n (2) `prefix` is set to \"myoidc:\" and `claim` is set to \"email\". If the\n JWT `email` claim contains value \"userA@myoidc.tld\", the resulting\n mapped value will be \"myoidc:userA@myoidc.tld\".\n (3) `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 (a) \"username\": the mapped value will be \"https://myoidc.tld#userA\"\n (b) \"email\": the mapped value will be \"userA@myoidc.tld\"", + Description: "prefixPolicy specifies how a prefix should apply.\n\nBy default, claims other than `email` will be prefixed with the issuer URL to prevent naming clashes with other plugins.\n\nSet to \"NoPrefix\" to disable prefixing.\n\nExample:\n (1) `prefix` is set to \"myoidc:\" and `claim` is set to \"username\".\n If the JWT claim `username` contains value `userA`, the resulting\n mapped value will be \"myoidc:userA\".\n (2) `prefix` is set to \"myoidc:\" and `claim` is set to \"email\". If the\n JWT `email` claim contains value \"userA@myoidc.tld\", the resulting\n mapped value will be \"myoidc:userA@myoidc.tld\".\n (3) `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 (a) \"username\": the mapped value will be \"https://myoidc.tld#userA\"\n (b) \"email\": the mapped value will be \"userA@myoidc.tld\"", Default: "", Type: []string{"string"}, Format: "", @@ -19611,7 +19612,7 @@ func schema_openshift_api_config_v1_VSpherePlatformFailureDomainSpec(ref common. }, "topology": { SchemaProps: spec.SchemaProps{ - Description: "Topology describes a given failure domain using vSphere constructs", + Description: "topology describes a given failure domain using vSphere constructs", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/config/v1.VSpherePlatformTopology"), }, @@ -20445,7 +20446,7 @@ func schema_openshift_api_config_v1alpha1_EtcdBackupSpec(ref common.ReferenceCal Properties: map[string]spec.Schema{ "schedule": { SchemaProps: spec.SchemaProps{ - 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.", + 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.", Default: "", Type: []string{"string"}, Format: "", @@ -20461,14 +20462,14 @@ func schema_openshift_api_config_v1alpha1_EtcdBackupSpec(ref common.ReferenceCal }, "retentionPolicy": { SchemaProps: spec.SchemaProps{ - Description: "RetentionPolicy defines the retention policy for retaining and deleting existing backups.", + Description: "retentionPolicy defines the retention policy for retaining and deleting existing backups.", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/config/v1alpha1.RetentionPolicy"), }, }, "pvcName": { SchemaProps: spec.SchemaProps{ - 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.", + 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.", Default: "", Type: []string{"string"}, Format: "", @@ -20511,7 +20512,7 @@ func schema_openshift_api_config_v1alpha1_FulcioCAWithRekor(ref common.Reference }, }, }, - Required: []string{"fulcioCAData", "rekorKeyData"}, + Required: []string{"fulcioCAData", "rekorKeyData", "fulcioSubject"}, }, }, Dependencies: []string{ @@ -21111,7 +21112,7 @@ func schema_openshift_api_config_v1alpha1_RetentionNumberConfig(ref common.Refer Properties: map[string]spec.Schema{ "maxNumberOfBackups": { SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"integer"}, Format: "int32", }, @@ -21132,7 +21133,7 @@ func schema_openshift_api_config_v1alpha1_RetentionPolicy(ref common.ReferenceCa Properties: map[string]spec.Schema{ "retentionType": { SchemaProps: spec.SchemaProps{ - 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", + 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", Default: "", Type: []string{"string"}, Format: "", @@ -21141,13 +21142,13 @@ func schema_openshift_api_config_v1alpha1_RetentionPolicy(ref common.ReferenceCa }, "retentionNumber": { SchemaProps: spec.SchemaProps{ - Description: "RetentionNumber configures the retention policy based on the number of backups", + Description: "retentionNumber configures the retention policy based on the number of backups", Ref: ref("github.com/openshift/api/config/v1alpha1.RetentionNumberConfig"), }, }, "retentionSize": { SchemaProps: spec.SchemaProps{ - Description: "RetentionSize configures the retention policy based on the size of backups", + Description: "retentionSize configures the retention policy based on the size of backups", Ref: ref("github.com/openshift/api/config/v1alpha1.RetentionSizeConfig"), }, }, @@ -21182,7 +21183,7 @@ func schema_openshift_api_config_v1alpha1_RetentionSizeConfig(ref common.Referen Properties: map[string]spec.Schema{ "maxSizeOfBackupsGb": { SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"integer"}, Format: "int32", }, @@ -21211,7 +21212,7 @@ func schema_openshift_api_console_v1_ApplicationMenuSpec(ref common.ReferenceCal }, "imageURL": { SchemaProps: spec.SchemaProps{ - 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.", + 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{"string"}, Format: "", }, @@ -23208,6 +23209,7 @@ func schema_openshift_api_example_v1_CELUnion(ref common.ReferenceCallback) comm }, }, }, + Required: []string{"type"}, }, VendorExtensible: spec.VendorExtensible{ Extensions: spec.Extensions{ @@ -23240,6 +23242,7 @@ func schema_openshift_api_example_v1_EvolvingUnion(ref common.ReferenceCallback) }, }, }, + Required: []string{"type"}, }, }, } @@ -24147,7 +24150,7 @@ func schema_openshift_api_image_v1_Image(ref common.ReferenceCallback) common.Op }, "dockerImageReference": { SchemaProps: spec.SchemaProps{ - Description: "DockerImageReference is the string that can be used to pull this image.", + Description: "dockerImageReference is the string that can be used to pull this image.", Type: []string{"string"}, Format: "", }, @@ -24159,27 +24162,27 @@ func schema_openshift_api_image_v1_Image(ref common.ReferenceCallback) common.Op }, }, SchemaProps: spec.SchemaProps{ - Description: "DockerImageMetadata contains metadata about this image", + Description: "dockerImageMetadata contains metadata about this image", Ref: ref("k8s.io/apimachinery/pkg/runtime.RawExtension"), }, }, "dockerImageMetadataVersion": { SchemaProps: spec.SchemaProps{ - Description: "DockerImageMetadataVersion conveys the version of the object, which if empty defaults to \"1.0\"", + Description: "dockerImageMetadataVersion conveys the version of the object, which if empty defaults to \"1.0\"", Type: []string{"string"}, Format: "", }, }, "dockerImageManifest": { SchemaProps: spec.SchemaProps{ - Description: "DockerImageManifest is the raw JSON of the manifest", + Description: "dockerImageManifest is the raw JSON of the manifest", Type: []string{"string"}, Format: "", }, }, "dockerImageLayers": { SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -24199,7 +24202,7 @@ func schema_openshift_api_image_v1_Image(ref common.ReferenceCallback) common.Op }, }, SchemaProps: spec.SchemaProps{ - Description: "Signatures holds all signatures of the image.", + Description: "signatures holds all signatures of the image.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -24213,7 +24216,7 @@ func schema_openshift_api_image_v1_Image(ref common.ReferenceCallback) common.Op }, "dockerImageSignatures": { SchemaProps: spec.SchemaProps{ - Description: "DockerImageSignatures provides the signatures as opaque blobs. This is a part of manifest schema v1.", + Description: "dockerImageSignatures provides the signatures as opaque blobs. This is a part of manifest schema v1.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -24227,21 +24230,21 @@ func schema_openshift_api_image_v1_Image(ref common.ReferenceCallback) common.Op }, "dockerImageManifestMediaType": { SchemaProps: spec.SchemaProps{ - Description: "DockerImageManifestMediaType specifies the mediaType of manifest. This is a part of manifest schema v2.", + Description: "dockerImageManifestMediaType specifies the mediaType of manifest. This is a part of manifest schema v2.", Type: []string{"string"}, Format: "", }, }, "dockerImageConfig": { SchemaProps: spec.SchemaProps{ - 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.", + 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{"string"}, Format: "", }, }, "dockerImageManifests": { SchemaProps: spec.SchemaProps{ - Description: "DockerImageManifests holds information about sub-manifests when the image represents a manifest list. When this field is present, no DockerImageLayers should be specified.", + 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: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -24328,34 +24331,34 @@ func schema_openshift_api_image_v1_ImageImportSpec(ref common.ReferenceCallback) Properties: map[string]spec.Schema{ "from": { SchemaProps: spec.SchemaProps{ - Description: "From is the source of an image to import; only kind DockerImage is allowed", + Description: "from is the source of an image to import; only kind DockerImage is allowed", Default: map[string]interface{}{}, Ref: ref("k8s.io/api/core/v1.ObjectReference"), }, }, "to": { SchemaProps: spec.SchemaProps{ - 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", + 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: ref("k8s.io/api/core/v1.LocalObjectReference"), }, }, "importPolicy": { SchemaProps: spec.SchemaProps{ - Description: "ImportPolicy is the policy controlling how the image is imported", + Description: "importPolicy is the policy controlling how the image is imported", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/image/v1.TagImportPolicy"), }, }, "referencePolicy": { SchemaProps: spec.SchemaProps{ - Description: "ReferencePolicy defines how other components should consume the image", + Description: "referencePolicy defines how other components should consume the image", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/image/v1.TagReferencePolicy"), }, }, "includeManifest": { SchemaProps: spec.SchemaProps{ - Description: "IncludeManifest determines if the manifest for each image is returned in the response", + Description: "includeManifest determines if the manifest for each image is returned in the response", Type: []string{"boolean"}, Format: "", }, @@ -24378,27 +24381,27 @@ func schema_openshift_api_image_v1_ImageImportStatus(ref common.ReferenceCallbac Properties: map[string]spec.Schema{ "status": { SchemaProps: spec.SchemaProps{ - Description: "Status is the status of the image import, including errors encountered while retrieving the image", + Description: "status is the status of the image import, including errors encountered while retrieving the image", Default: map[string]interface{}{}, Ref: ref("k8s.io/apimachinery/pkg/apis/meta/v1.Status"), }, }, "image": { SchemaProps: spec.SchemaProps{ - Description: "Image is the metadata of that image, if the image was located", + Description: "image is the metadata of that image, if the image was located", Ref: ref("github.com/openshift/api/image/v1.Image"), }, }, "tag": { SchemaProps: spec.SchemaProps{ - Description: "Tag is the tag this image was located under, if any", + Description: "tag is the tag this image was located under, if any", Type: []string{"string"}, Format: "", }, }, "manifests": { SchemaProps: spec.SchemaProps{ - Description: "Manifests holds sub-manifests metadata when importing a manifest list", + Description: "manifests holds sub-manifests metadata when importing a manifest list", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -24428,7 +24431,7 @@ func schema_openshift_api_image_v1_ImageLayer(ref common.ReferenceCallback) comm Properties: map[string]spec.Schema{ "name": { SchemaProps: spec.SchemaProps{ - Description: "Name of the layer as defined by the underlying store.", + Description: "name of the layer as defined by the underlying store.", Default: "", Type: []string{"string"}, Format: "", @@ -24436,7 +24439,7 @@ func schema_openshift_api_image_v1_ImageLayer(ref common.ReferenceCallback) comm }, "size": { SchemaProps: spec.SchemaProps{ - Description: "Size of the layer in bytes as defined by the underlying store.", + Description: "size of the layer in bytes as defined by the underlying store.", Default: 0, Type: []string{"integer"}, Format: "int64", @@ -24444,7 +24447,7 @@ func schema_openshift_api_image_v1_ImageLayer(ref common.ReferenceCallback) comm }, "mediaType": { SchemaProps: spec.SchemaProps{ - Description: "MediaType of the referenced object.", + Description: "mediaType of the referenced object.", Default: "", Type: []string{"string"}, Format: "", @@ -24466,14 +24469,14 @@ func schema_openshift_api_image_v1_ImageLayerData(ref common.ReferenceCallback) Properties: map[string]spec.Schema{ "size": { SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"integer"}, Format: "int64", }, }, "mediaType": { SchemaProps: spec.SchemaProps{ - Description: "MediaType of the referenced object.", + Description: "mediaType of the referenced object.", Default: "", Type: []string{"string"}, Format: "", @@ -24516,7 +24519,7 @@ func schema_openshift_api_image_v1_ImageList(ref common.ReferenceCallback) commo }, "items": { SchemaProps: spec.SchemaProps{ - Description: "Items is a list of images", + Description: "items is a list of images", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -24568,7 +24571,7 @@ func schema_openshift_api_image_v1_ImageManifest(ref common.ReferenceCallback) c Properties: map[string]spec.Schema{ "digest": { SchemaProps: spec.SchemaProps{ - Description: "Digest is the unique identifier for the manifest. It refers to an Image object.", + Description: "digest is the unique identifier for the manifest. It refers to an Image object.", Default: "", Type: []string{"string"}, Format: "", @@ -24576,7 +24579,7 @@ func schema_openshift_api_image_v1_ImageManifest(ref common.ReferenceCallback) c }, "mediaType": { SchemaProps: spec.SchemaProps{ - 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.", + 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.", Default: "", Type: []string{"string"}, Format: "", @@ -24584,7 +24587,7 @@ func schema_openshift_api_image_v1_ImageManifest(ref common.ReferenceCallback) c }, "manifestSize": { SchemaProps: spec.SchemaProps{ - Description: "ManifestSize represents the size of the raw object contents, in bytes.", + Description: "manifestSize represents the size of the raw object contents, in bytes.", Default: 0, Type: []string{"integer"}, Format: "int64", @@ -24592,7 +24595,7 @@ func schema_openshift_api_image_v1_ImageManifest(ref common.ReferenceCallback) c }, "architecture": { SchemaProps: spec.SchemaProps{ - Description: "Architecture specifies the supported CPU architecture, for example `amd64` or `ppc64le`.", + Description: "architecture specifies the supported CPU architecture, for example `amd64` or `ppc64le`.", Default: "", Type: []string{"string"}, Format: "", @@ -24600,7 +24603,7 @@ func schema_openshift_api_image_v1_ImageManifest(ref common.ReferenceCallback) c }, "os": { SchemaProps: spec.SchemaProps{ - Description: "OS specifies the operating system, for example `linux`.", + Description: "os specifies the operating system, for example `linux`.", Default: "", Type: []string{"string"}, Format: "", @@ -24608,7 +24611,7 @@ func schema_openshift_api_image_v1_ImageManifest(ref common.ReferenceCallback) c }, "variant": { SchemaProps: spec.SchemaProps{ - 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.", + 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{"string"}, Format: "", }, @@ -24671,7 +24674,7 @@ func schema_openshift_api_image_v1_ImageSignature(ref common.ReferenceCallback) }, }, SchemaProps: spec.SchemaProps{ - Description: "Conditions represent the latest available observations of a signature's current state.", + Description: "conditions represent the latest available observations of a signature's current state.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -24763,14 +24766,14 @@ func schema_openshift_api_image_v1_ImageStream(ref common.ReferenceCallback) com }, "spec": { SchemaProps: spec.SchemaProps{ - Description: "Spec describes the desired state of this stream", + Description: "spec describes the desired state of this stream", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/image/v1.ImageStreamSpec"), }, }, "status": { SchemaProps: spec.SchemaProps{ - Description: "Status describes the current state of this stream", + Description: "status describes the current state of this stream", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/image/v1.ImageStreamStatus"), }, @@ -24813,7 +24816,7 @@ func schema_openshift_api_image_v1_ImageStreamImage(ref common.ReferenceCallback }, "image": { SchemaProps: spec.SchemaProps{ - Description: "Image associated with the ImageStream and image name.", + Description: "image associated with the ImageStream and image name.", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/image/v1.Image"), }, @@ -24857,14 +24860,14 @@ func schema_openshift_api_image_v1_ImageStreamImport(ref common.ReferenceCallbac }, "spec": { SchemaProps: spec.SchemaProps{ - Description: "Spec is a description of the images that the user wishes to import", + Description: "spec is a description of the images that the user wishes to import", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/image/v1.ImageStreamImportSpec"), }, }, "status": { SchemaProps: spec.SchemaProps{ - Description: "Status is the result of importing the image", + Description: "status is the result of importing the image", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/image/v1.ImageStreamImportStatus"), }, @@ -24887,7 +24890,7 @@ func schema_openshift_api_image_v1_ImageStreamImportSpec(ref common.ReferenceCal Properties: map[string]spec.Schema{ "import": { SchemaProps: spec.SchemaProps{ - 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.", + 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.", Default: false, Type: []string{"boolean"}, Format: "", @@ -24895,13 +24898,13 @@ func schema_openshift_api_image_v1_ImageStreamImportSpec(ref common.ReferenceCal }, "repository": { SchemaProps: spec.SchemaProps{ - 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.", + 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: ref("github.com/openshift/api/image/v1.RepositoryImportSpec"), }, }, "images": { SchemaProps: spec.SchemaProps{ - Description: "Images are a list of individual images to import.", + Description: "images are a list of individual images to import.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -24931,19 +24934,19 @@ func schema_openshift_api_image_v1_ImageStreamImportStatus(ref common.ReferenceC Properties: map[string]spec.Schema{ "import": { SchemaProps: spec.SchemaProps{ - Description: "Import is the image stream that was successfully updated or created when 'to' was set.", + Description: "import is the image stream that was successfully updated or created when 'to' was set.", Ref: ref("github.com/openshift/api/image/v1.ImageStream"), }, }, "repository": { SchemaProps: spec.SchemaProps{ - Description: "Repository is set if spec.repository was set to the outcome of the import", + Description: "repository is set if spec.repository was set to the outcome of the import", Ref: ref("github.com/openshift/api/image/v1.RepositoryImportStatus"), }, }, "images": { SchemaProps: spec.SchemaProps{ - Description: "Images is set with the result of importing spec.images", + Description: "images is set with the result of importing spec.images", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -25060,7 +25063,7 @@ func schema_openshift_api_image_v1_ImageStreamList(ref common.ReferenceCallback) }, "items": { SchemaProps: spec.SchemaProps{ - Description: "Items is a list of imageStreams", + Description: "items is a list of imageStreams", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -25111,14 +25114,14 @@ func schema_openshift_api_image_v1_ImageStreamMapping(ref common.ReferenceCallba }, "image": { SchemaProps: spec.SchemaProps{ - Description: "Image is a container image.", + Description: "image is a container image.", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/image/v1.Image"), }, }, "tag": { SchemaProps: spec.SchemaProps{ - Description: "Tag is a string value this image can be located with inside the stream.", + Description: "tag is a string value this image can be located with inside the stream.", Default: "", Type: []string{"string"}, Format: "", @@ -25191,7 +25194,7 @@ func schema_openshift_api_image_v1_ImageStreamStatus(ref common.ReferenceCallbac Properties: map[string]spec.Schema{ "dockerImageRepository": { SchemaProps: spec.SchemaProps{ - Description: "DockerImageRepository represents the effective location this stream may be accessed at. May be empty until the server determines where the repository is located", + Description: "dockerImageRepository represents the effective location this stream may be accessed at. May be empty until the server determines where the repository is located", Default: "", Type: []string{"string"}, Format: "", @@ -25199,7 +25202,7 @@ func schema_openshift_api_image_v1_ImageStreamStatus(ref common.ReferenceCallbac }, "publicDockerImageRepository": { SchemaProps: spec.SchemaProps{ - 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.", + 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{"string"}, Format: "", }, @@ -25212,7 +25215,7 @@ func schema_openshift_api_image_v1_ImageStreamStatus(ref common.ReferenceCallbac }, }, SchemaProps: spec.SchemaProps{ - Description: "Tags are a historical record of images associated with each tag. The first entry in the TagEvent array is the currently tagged image.", + 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: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -25342,7 +25345,7 @@ func schema_openshift_api_image_v1_ImageStreamTagList(ref common.ReferenceCallba }, "items": { SchemaProps: spec.SchemaProps{ - Description: "Items is the list of image stream tags", + Description: "items is the list of image stream tags", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -25448,7 +25451,7 @@ func schema_openshift_api_image_v1_ImageTagList(ref common.ReferenceCallback) co }, "items": { SchemaProps: spec.SchemaProps{ - Description: "Items is the list of image stream tags", + Description: "items is the list of image stream tags", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -25478,7 +25481,7 @@ func schema_openshift_api_image_v1_NamedTagEventList(ref common.ReferenceCallbac Properties: map[string]spec.Schema{ "tag": { SchemaProps: spec.SchemaProps{ - Description: "Tag is the tag for which the history is recorded", + Description: "tag is the tag for which the history is recorded", Default: "", Type: []string{"string"}, Format: "", @@ -25500,7 +25503,7 @@ func schema_openshift_api_image_v1_NamedTagEventList(ref common.ReferenceCallbac }, "conditions": { SchemaProps: spec.SchemaProps{ - Description: "Conditions is an array of conditions that apply to the tag event list.", + Description: "conditions is an array of conditions that apply to the tag event list.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -25530,28 +25533,28 @@ func schema_openshift_api_image_v1_RepositoryImportSpec(ref common.ReferenceCall Properties: map[string]spec.Schema{ "from": { SchemaProps: spec.SchemaProps{ - Description: "From is the source for the image repository to import; only kind DockerImage and a name of a container image repository is allowed", + 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: map[string]interface{}{}, Ref: ref("k8s.io/api/core/v1.ObjectReference"), }, }, "importPolicy": { SchemaProps: spec.SchemaProps{ - Description: "ImportPolicy is the policy controlling how the image is imported", + Description: "importPolicy is the policy controlling how the image is imported", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/image/v1.TagImportPolicy"), }, }, "referencePolicy": { SchemaProps: spec.SchemaProps{ - Description: "ReferencePolicy defines how other components should consume the image", + Description: "referencePolicy defines how other components should consume the image", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/image/v1.TagReferencePolicy"), }, }, "includeManifest": { SchemaProps: spec.SchemaProps{ - Description: "IncludeManifest determines if the manifest for each image is returned in the response", + Description: "includeManifest determines if the manifest for each image is returned in the response", Type: []string{"boolean"}, Format: "", }, @@ -25574,14 +25577,14 @@ func schema_openshift_api_image_v1_RepositoryImportStatus(ref common.ReferenceCa Properties: map[string]spec.Schema{ "status": { SchemaProps: spec.SchemaProps{ - Description: "Status reflects whether any failure occurred during import", + Description: "status reflects whether any failure occurred during import", Default: map[string]interface{}{}, Ref: ref("k8s.io/apimachinery/pkg/apis/meta/v1.Status"), }, }, "images": { SchemaProps: spec.SchemaProps{ - Description: "Images is a list of images successfully retrieved by the import of the repository.", + Description: "images is a list of images successfully retrieved by the import of the repository.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -25595,7 +25598,7 @@ func schema_openshift_api_image_v1_RepositoryImportStatus(ref common.ReferenceCa }, "additionalTags": { SchemaProps: spec.SchemaProps{ - Description: "AdditionalTags are tags that exist in the repository but were not imported because a maximum limit of automatic imports was applied.", + Description: "additionalTags are tags that exist in the repository but were not imported because a maximum limit of automatic imports was applied.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -25676,7 +25679,7 @@ func schema_openshift_api_image_v1_SignatureCondition(ref common.ReferenceCallba Properties: map[string]spec.Schema{ "type": { SchemaProps: spec.SchemaProps{ - Description: "Type of signature condition, Complete or Failed.", + Description: "type of signature condition, Complete or Failed.", Default: "", Type: []string{"string"}, Format: "", @@ -25684,7 +25687,7 @@ func schema_openshift_api_image_v1_SignatureCondition(ref common.ReferenceCallba }, "status": { SchemaProps: spec.SchemaProps{ - Description: "Status of the condition, one of True, False, Unknown.", + Description: "status of the condition, one of True, False, Unknown.", Default: "", Type: []string{"string"}, Format: "", @@ -25734,7 +25737,7 @@ func schema_openshift_api_image_v1_SignatureGenericEntity(ref common.ReferenceCa Properties: map[string]spec.Schema{ "organization": { SchemaProps: spec.SchemaProps{ - Description: "Organization name.", + Description: "organization name.", Type: []string{"string"}, Format: "", }, @@ -25761,7 +25764,7 @@ func schema_openshift_api_image_v1_SignatureIssuer(ref common.ReferenceCallback) Properties: map[string]spec.Schema{ "organization": { SchemaProps: spec.SchemaProps{ - Description: "Organization name.", + Description: "organization name.", Type: []string{"string"}, Format: "", }, @@ -25788,7 +25791,7 @@ func schema_openshift_api_image_v1_SignatureSubject(ref common.ReferenceCallback Properties: map[string]spec.Schema{ "organization": { SchemaProps: spec.SchemaProps{ - Description: "Organization name.", + Description: "organization name.", Type: []string{"string"}, Format: "", }, @@ -25824,13 +25827,13 @@ func schema_openshift_api_image_v1_TagEvent(ref common.ReferenceCallback) common Properties: map[string]spec.Schema{ "created": { SchemaProps: spec.SchemaProps{ - Description: "Created holds the time the TagEvent was created", + Description: "created holds the time the TagEvent was created", Ref: ref("k8s.io/apimachinery/pkg/apis/meta/v1.Time"), }, }, "dockerImageReference": { SchemaProps: spec.SchemaProps{ - Description: "DockerImageReference is the string that can be used to pull this image", + Description: "dockerImageReference is the string that can be used to pull this image", Default: "", Type: []string{"string"}, Format: "", @@ -25838,7 +25841,7 @@ func schema_openshift_api_image_v1_TagEvent(ref common.ReferenceCallback) common }, "image": { SchemaProps: spec.SchemaProps{ - Description: "Image is the image", + Description: "image is the image", Default: "", Type: []string{"string"}, Format: "", @@ -25846,7 +25849,7 @@ func schema_openshift_api_image_v1_TagEvent(ref common.ReferenceCallback) common }, "generation": { SchemaProps: spec.SchemaProps{ - Description: "Generation is the spec tag generation that resulted in this tag being updated", + Description: "generation is the spec tag generation that resulted in this tag being updated", Default: 0, Type: []string{"integer"}, Format: "int64", @@ -25870,7 +25873,7 @@ func schema_openshift_api_image_v1_TagEventCondition(ref common.ReferenceCallbac Properties: map[string]spec.Schema{ "type": { SchemaProps: spec.SchemaProps{ - Description: "Type of tag event condition, currently only ImportSuccess", + Description: "type of tag event condition, currently only ImportSuccess", Default: "", Type: []string{"string"}, Format: "", @@ -25878,7 +25881,7 @@ func schema_openshift_api_image_v1_TagEventCondition(ref common.ReferenceCallbac }, "status": { SchemaProps: spec.SchemaProps{ - Description: "Status of the condition, one of True, False, Unknown.", + Description: "status of the condition, one of True, False, Unknown.", Default: "", Type: []string{"string"}, Format: "", @@ -25886,27 +25889,27 @@ func schema_openshift_api_image_v1_TagEventCondition(ref common.ReferenceCallbac }, "lastTransitionTime": { SchemaProps: spec.SchemaProps{ - Description: "LastTransitionTIme is the time the condition transitioned from one status to another.", + Description: "lastTransitionTime is the time the condition transitioned from one status to another.", Ref: ref("k8s.io/apimachinery/pkg/apis/meta/v1.Time"), }, }, "reason": { SchemaProps: spec.SchemaProps{ - Description: "Reason is a brief machine readable explanation for the condition's last transition.", + Description: "reason is a brief machine readable explanation for the condition's last transition.", Type: []string{"string"}, Format: "", }, }, "message": { SchemaProps: spec.SchemaProps{ - Description: "Message is a human readable description of the details about last transition, complementing reason.", + Description: "message is a human readable description of the details about last transition, complementing reason.", Type: []string{"string"}, Format: "", }, }, "generation": { SchemaProps: spec.SchemaProps{ - Description: "Generation is the spec tag generation that this status corresponds to", + Description: "generation is the spec tag generation that this status corresponds to", Default: 0, Type: []string{"integer"}, Format: "int64", @@ -25930,21 +25933,21 @@ func schema_openshift_api_image_v1_TagImportPolicy(ref common.ReferenceCallback) Properties: map[string]spec.Schema{ "insecure": { SchemaProps: spec.SchemaProps{ - Description: "Insecure is true if the server may bypass certificate verification or connect directly over HTTP during image import.", + Description: "insecure is true if the server may bypass certificate verification or connect directly over HTTP during image import.", Type: []string{"boolean"}, Format: "", }, }, "scheduled": { SchemaProps: spec.SchemaProps{ - Description: "Scheduled indicates to the server that this tag should be periodically checked to ensure it is up to date, and imported", + Description: "scheduled indicates to the server that this tag should be periodically checked to ensure it is up to date, and imported", Type: []string{"boolean"}, Format: "", }, }, "importMode": { SchemaProps: spec.SchemaProps{ - Description: "ImportMode describes how to import an image manifest.", + Description: "importMode describes how to import an image manifest.", Type: []string{"string"}, Format: "", }, @@ -25964,7 +25967,7 @@ func schema_openshift_api_image_v1_TagReference(ref common.ReferenceCallback) co Properties: map[string]spec.Schema{ "name": { SchemaProps: spec.SchemaProps{ - Description: "Name of the tag", + Description: "name of the tag", Default: "", Type: []string{"string"}, Format: "", @@ -25994,28 +25997,28 @@ func schema_openshift_api_image_v1_TagReference(ref common.ReferenceCallback) co }, "reference": { SchemaProps: spec.SchemaProps{ - Description: "Reference states if the tag will be imported. Default value is false, which means the tag will be imported.", + Description: "reference states if the tag will be imported. Default value is false, which means the tag will be imported.", Type: []string{"boolean"}, Format: "", }, }, "generation": { SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"integer"}, Format: "int64", }, }, "importPolicy": { SchemaProps: spec.SchemaProps{ - Description: "ImportPolicy is information that controls how images may be imported by the server.", + Description: "importPolicy is information that controls how images may be imported by the server.", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/image/v1.TagImportPolicy"), }, }, "referencePolicy": { SchemaProps: spec.SchemaProps{ - Description: "ReferencePolicy defines how other components should consume the image.", + Description: "referencePolicy defines how other components should consume the image.", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/image/v1.TagReferencePolicy"), }, @@ -26038,7 +26041,7 @@ func schema_openshift_api_image_v1_TagReferencePolicy(ref common.ReferenceCallba Properties: map[string]spec.Schema{ "type": { SchemaProps: spec.SchemaProps{ - 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.", + 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.", Default: "", Type: []string{"string"}, Format: "", @@ -26660,7 +26663,7 @@ func schema_openshift_api_kubecontrolplane_v1_KubeAPIServerConfig(ref common.Ref }, "userAgentMatchingConfig": { SchemaProps: spec.SchemaProps{ - Description: "UserAgentMatchingConfig controls how API calls from *voluntarily* identifying clients will be handled. THIS DOES NOT DEFEND AGAINST MALICIOUS CLIENTS!", + Description: "userAgentMatchingConfig controls how API calls from *voluntarily* identifying clients will be handled. THIS DOES NOT DEFEND AGAINST MALICIOUS CLIENTS!", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/kubecontrolplane/v1.UserAgentMatchingConfig"), }, @@ -26909,7 +26912,7 @@ func schema_openshift_api_kubecontrolplane_v1_KubeletConnectionInfo(ref common.R }, "certFile": { SchemaProps: spec.SchemaProps{ - Description: "CertFile is a file containing a PEM-encoded certificate", + Description: "certFile is a file containing a PEM-encoded certificate", Default: "", Type: []string{"string"}, Format: "", @@ -26917,7 +26920,7 @@ func schema_openshift_api_kubecontrolplane_v1_KubeletConnectionInfo(ref common.R }, "keyFile": { SchemaProps: spec.SchemaProps{ - Description: "KeyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile", + Description: "keyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile", Default: "", Type: []string{"string"}, Format: "", @@ -27065,7 +27068,7 @@ func schema_openshift_api_kubecontrolplane_v1_ServiceServingCert(ref common.Refe Properties: map[string]spec.Schema{ "certFile": { SchemaProps: spec.SchemaProps{ - Description: "CertFile is a file containing a PEM-encoded certificate", + Description: "certFile is a file containing a PEM-encoded certificate", Default: "", Type: []string{"string"}, Format: "", @@ -27110,7 +27113,7 @@ func schema_openshift_api_kubecontrolplane_v1_UserAgentDenyRule(ref common.Refer }, "rejectionMessage": { SchemaProps: spec.SchemaProps{ - Description: "RejectionMessage is the message shown when rejecting a client. If it is not a set, the default message is used.", + Description: "rejectionMessage is the message shown when rejecting a client. If it is not a set, the default message is used.", Default: "", Type: []string{"string"}, Format: "", @@ -27258,7 +27261,7 @@ func schema_openshift_api_legacyconfig_v1_ActiveDirectoryConfig(ref common.Refer }, "userNameAttributes": { SchemaProps: spec.SchemaProps{ - Description: "UserNameAttributes defines which attributes on an LDAP user entry will be interpreted as its OpenShift user name.", + Description: "userNameAttributes defines which attributes on an LDAP user entry will be interpreted as its OpenShift user name.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -27273,7 +27276,7 @@ func schema_openshift_api_legacyconfig_v1_ActiveDirectoryConfig(ref common.Refer }, "groupMembershipAttributes": { SchemaProps: spec.SchemaProps{ - Description: "GroupMembershipAttributes defines which attributes on an LDAP user entry will be interpreted as the groups it is a member of", + Description: "groupMembershipAttributes defines which attributes on an LDAP user entry will be interpreted as the groups it is a member of", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -27304,7 +27307,7 @@ func schema_openshift_api_legacyconfig_v1_AdmissionConfig(ref common.ReferenceCa Properties: map[string]spec.Schema{ "pluginConfig": { SchemaProps: spec.SchemaProps{ - Description: "PluginConfig allows specifying a configuration file per admission control plugin", + Description: "pluginConfig allows specifying a configuration file per admission control plugin", Type: []string{"object"}, AdditionalProperties: &spec.SchemaOrBool{ Allows: true, @@ -27318,7 +27321,7 @@ func schema_openshift_api_legacyconfig_v1_AdmissionConfig(ref common.ReferenceCa }, "pluginOrderOverride": { SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -27349,7 +27352,7 @@ func schema_openshift_api_legacyconfig_v1_AdmissionPluginConfig(ref common.Refer Properties: map[string]spec.Schema{ "location": { SchemaProps: spec.SchemaProps{ - Description: "Location is the path to a configuration file that contains the plugin's configuration", + Description: "location is the path to a configuration file that contains the plugin's configuration", Default: "", Type: []string{"string"}, Format: "", @@ -27357,7 +27360,7 @@ func schema_openshift_api_legacyconfig_v1_AdmissionPluginConfig(ref common.Refer }, "configuration": { SchemaProps: spec.SchemaProps{ - 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.", + 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: ref("k8s.io/apimachinery/pkg/runtime.RawExtension"), }, }, @@ -27379,7 +27382,7 @@ func schema_openshift_api_legacyconfig_v1_AggregatorConfig(ref common.ReferenceC Properties: map[string]spec.Schema{ "proxyClientInfo": { SchemaProps: spec.SchemaProps{ - Description: "ProxyClientInfo specifies the client cert/key to use when proxying to aggregated API servers", + Description: "proxyClientInfo specifies the client cert/key to use when proxying to aggregated API servers", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/legacyconfig/v1.CertInfo"), }, @@ -27469,7 +27472,7 @@ func schema_openshift_api_legacyconfig_v1_AuditConfig(ref common.ReferenceCallba }, "policyFile": { SchemaProps: spec.SchemaProps{ - Description: "PolicyFile is a path to the file that defines the audit policy configuration.", + Description: "policyFile is a path to the file that defines the audit policy configuration.", Default: "", Type: []string{"string"}, Format: "", @@ -27477,7 +27480,7 @@ func schema_openshift_api_legacyconfig_v1_AuditConfig(ref common.ReferenceCallba }, "policyConfiguration": { SchemaProps: spec.SchemaProps{ - 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.", + 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: ref("k8s.io/apimachinery/pkg/runtime.RawExtension"), }, }, @@ -27530,7 +27533,7 @@ func schema_openshift_api_legacyconfig_v1_AugmentedActiveDirectoryConfig(ref com }, "userNameAttributes": { SchemaProps: spec.SchemaProps{ - Description: "UserNameAttributes defines which attributes on an LDAP user entry will be interpreted as its OpenShift user name.", + Description: "userNameAttributes defines which attributes on an LDAP user entry will be interpreted as its OpenShift user name.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -27545,7 +27548,7 @@ func schema_openshift_api_legacyconfig_v1_AugmentedActiveDirectoryConfig(ref com }, "groupMembershipAttributes": { SchemaProps: spec.SchemaProps{ - Description: "GroupMembershipAttributes defines which attributes on an LDAP user entry will be interpreted as the groups it is a member of", + Description: "groupMembershipAttributes defines which attributes on an LDAP user entry will be interpreted as the groups it is a member of", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -27575,7 +27578,7 @@ func schema_openshift_api_legacyconfig_v1_AugmentedActiveDirectoryConfig(ref com }, "groupNameAttributes": { SchemaProps: spec.SchemaProps{ - Description: "GroupNameAttributes defines which attributes on an LDAP group entry will be interpreted as its name to use for an OpenShift group", + Description: "groupNameAttributes defines which attributes on an LDAP group entry will be interpreted as its name to use for an OpenShift group", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -27620,7 +27623,7 @@ func schema_openshift_api_legacyconfig_v1_BasicAuthPasswordIdentityProvider(ref }, "url": { SchemaProps: spec.SchemaProps{ - Description: "URL is the remote URL to connect to", + Description: "url is the remote URL to connect to", Default: "", Type: []string{"string"}, Format: "", @@ -27628,7 +27631,7 @@ func schema_openshift_api_legacyconfig_v1_BasicAuthPasswordIdentityProvider(ref }, "ca": { SchemaProps: spec.SchemaProps{ - Description: "CA is the CA for verifying TLS connections", + Description: "ca is the CA for verifying TLS connections", Default: "", Type: []string{"string"}, Format: "", @@ -27636,7 +27639,7 @@ func schema_openshift_api_legacyconfig_v1_BasicAuthPasswordIdentityProvider(ref }, "certFile": { SchemaProps: spec.SchemaProps{ - Description: "CertFile is a file containing a PEM-encoded certificate", + Description: "certFile is a file containing a PEM-encoded certificate", Default: "", Type: []string{"string"}, Format: "", @@ -27644,7 +27647,7 @@ func schema_openshift_api_legacyconfig_v1_BasicAuthPasswordIdentityProvider(ref }, "keyFile": { SchemaProps: spec.SchemaProps{ - Description: "KeyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile", + Description: "keyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile", Default: "", Type: []string{"string"}, Format: "", @@ -27887,7 +27890,7 @@ func schema_openshift_api_legacyconfig_v1_CertInfo(ref common.ReferenceCallback) Properties: map[string]spec.Schema{ "certFile": { SchemaProps: spec.SchemaProps{ - Description: "CertFile is a file containing a PEM-encoded certificate", + Description: "certFile is a file containing a PEM-encoded certificate", Default: "", Type: []string{"string"}, Format: "", @@ -27895,7 +27898,7 @@ func schema_openshift_api_legacyconfig_v1_CertInfo(ref common.ReferenceCallback) }, "keyFile": { SchemaProps: spec.SchemaProps{ - Description: "KeyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile", + Description: "keyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile", Default: "", Type: []string{"string"}, Format: "", @@ -27917,7 +27920,7 @@ func schema_openshift_api_legacyconfig_v1_ClientConnectionOverrides(ref common.R Properties: map[string]spec.Schema{ "acceptContentTypes": { SchemaProps: spec.SchemaProps{ - 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.", + 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.", Default: "", Type: []string{"string"}, Format: "", @@ -27925,7 +27928,7 @@ func schema_openshift_api_legacyconfig_v1_ClientConnectionOverrides(ref common.R }, "contentType": { SchemaProps: spec.SchemaProps{ - Description: "ContentType is the content type used when sending data to the server from this client.", + Description: "contentType is the content type used when sending data to the server from this client.", Default: "", Type: []string{"string"}, Format: "", @@ -27933,7 +27936,7 @@ func schema_openshift_api_legacyconfig_v1_ClientConnectionOverrides(ref common.R }, "qps": { SchemaProps: spec.SchemaProps{ - Description: "QPS controls the number of queries per second allowed for this connection.", + Description: "qps controls the number of queries per second allowed for this connection.", Default: 0, Type: []string{"number"}, Format: "float", @@ -27941,7 +27944,7 @@ func schema_openshift_api_legacyconfig_v1_ClientConnectionOverrides(ref common.R }, "burst": { SchemaProps: spec.SchemaProps{ - Description: "Burst allows extra queries to accumulate when a client is exceeding its rate.", + Description: "burst allows extra queries to accumulate when a client is exceeding its rate.", Default: 0, Type: []string{"integer"}, Format: "int32", @@ -27963,7 +27966,7 @@ func schema_openshift_api_legacyconfig_v1_ClusterNetworkEntry(ref common.Referen Properties: map[string]spec.Schema{ "cidr": { SchemaProps: spec.SchemaProps{ - Description: "CIDR defines the total range of a cluster networks address space.", + Description: "cidr defines the total range of a cluster networks address space.", Default: "", Type: []string{"string"}, Format: "", @@ -27971,7 +27974,7 @@ func schema_openshift_api_legacyconfig_v1_ClusterNetworkEntry(ref common.Referen }, "hostSubnetLength": { SchemaProps: spec.SchemaProps{ - 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.", + 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.", Default: 0, Type: []string{"integer"}, Format: "int64", @@ -27993,7 +27996,7 @@ func schema_openshift_api_legacyconfig_v1_ControllerConfig(ref common.ReferenceC Properties: map[string]spec.Schema{ "controllers": { SchemaProps: spec.SchemaProps{ - 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 \"*\".", + 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: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -28008,13 +28011,13 @@ func schema_openshift_api_legacyconfig_v1_ControllerConfig(ref common.ReferenceC }, "election": { SchemaProps: spec.SchemaProps{ - 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.", + 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: ref("github.com/openshift/api/legacyconfig/v1.ControllerElectionConfig"), }, }, "serviceServingCert": { SchemaProps: spec.SchemaProps{ - Description: "ServiceServingCert holds configuration for service serving cert signer which creates cert/key pairs for pods fulfilling a service to serve with.", + Description: "serviceServingCert holds configuration for service serving cert signer which creates cert/key pairs for pods fulfilling a service to serve with.", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/legacyconfig/v1.ServiceServingCert"), }, @@ -28037,7 +28040,7 @@ func schema_openshift_api_legacyconfig_v1_ControllerElectionConfig(ref common.Re Properties: map[string]spec.Schema{ "lockName": { SchemaProps: spec.SchemaProps{ - Description: "LockName is the resource name used to act as the lock for determining which controller instance should lead.", + Description: "lockName is the resource name used to act as the lock for determining which controller instance should lead.", Default: "", Type: []string{"string"}, Format: "", @@ -28045,7 +28048,7 @@ func schema_openshift_api_legacyconfig_v1_ControllerElectionConfig(ref common.Re }, "lockNamespace": { SchemaProps: spec.SchemaProps{ - Description: "LockNamespace is the resource namespace used to act as the lock for determining which controller instance should lead. It defaults to \"kube-system\"", + Description: "lockNamespace is the resource namespace used to act as the lock for determining which controller instance should lead. It defaults to \"kube-system\"", Default: "", Type: []string{"string"}, Format: "", @@ -28053,7 +28056,7 @@ func schema_openshift_api_legacyconfig_v1_ControllerElectionConfig(ref common.Re }, "lockResource": { SchemaProps: spec.SchemaProps{ - Description: "LockResource is the group and resource name to use to coordinate for the controller lock. If unset, defaults to \"configmaps\".", + Description: "lockResource is the group and resource name to use to coordinate for the controller lock. If unset, defaults to \"configmaps\".", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/legacyconfig/v1.GroupResource"), }, @@ -28076,7 +28079,7 @@ func schema_openshift_api_legacyconfig_v1_DNSConfig(ref common.ReferenceCallback Properties: map[string]spec.Schema{ "bindAddress": { SchemaProps: spec.SchemaProps{ - Description: "BindAddress is the ip:port to serve DNS on", + Description: "bindAddress is the ip:port to serve DNS on", Default: "", Type: []string{"string"}, Format: "", @@ -28084,7 +28087,7 @@ func schema_openshift_api_legacyconfig_v1_DNSConfig(ref common.ReferenceCallback }, "bindNetwork": { SchemaProps: spec.SchemaProps{ - Description: "BindNetwork is the type of network to bind to - defaults to \"tcp4\", accepts \"tcp\", \"tcp4\", and \"tcp6\"", + Description: "bindNetwork is the type of network to bind to - defaults to \"tcp4\", accepts \"tcp\", \"tcp4\", and \"tcp6\"", Default: "", Type: []string{"string"}, Format: "", @@ -28092,7 +28095,7 @@ func schema_openshift_api_legacyconfig_v1_DNSConfig(ref common.ReferenceCallback }, "allowRecursiveQueries": { SchemaProps: spec.SchemaProps{ - 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.", + 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.", Default: false, Type: []string{"boolean"}, Format: "", @@ -28128,7 +28131,7 @@ func schema_openshift_api_legacyconfig_v1_DefaultAdmissionConfig(ref common.Refe }, "disable": { SchemaProps: spec.SchemaProps{ - Description: "Disable turns off an admission plugin that is enabled by default.", + Description: "disable turns off an admission plugin that is enabled by default.", Default: false, Type: []string{"boolean"}, Format: "", @@ -28177,7 +28180,7 @@ func schema_openshift_api_legacyconfig_v1_DockerConfig(ref common.ReferenceCallb Properties: map[string]spec.Schema{ "execHandlerName": { SchemaProps: spec.SchemaProps{ - Description: "ExecHandlerName is the name of the handler to use for executing commands in containers.", + Description: "execHandlerName is the name of the handler to use for executing commands in containers.", Default: "", Type: []string{"string"}, Format: "", @@ -28185,7 +28188,7 @@ func schema_openshift_api_legacyconfig_v1_DockerConfig(ref common.ReferenceCallb }, "dockerShimSocket": { SchemaProps: spec.SchemaProps{ - 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'", + 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'", Default: "", Type: []string{"string"}, Format: "", @@ -28193,7 +28196,7 @@ func schema_openshift_api_legacyconfig_v1_DockerConfig(ref common.ReferenceCallb }, "dockerShimRootDirectory": { SchemaProps: spec.SchemaProps{ - Description: "DockershimRootDirectory is the dockershim root directory.", + Description: "dockerShimRootDirectory is the dockershim root directory.", Default: "", Type: []string{"string"}, Format: "", @@ -28215,14 +28218,14 @@ func schema_openshift_api_legacyconfig_v1_EtcdConfig(ref common.ReferenceCallbac Properties: map[string]spec.Schema{ "servingInfo": { SchemaProps: spec.SchemaProps{ - Description: "ServingInfo describes how to start serving the etcd master", + Description: "servingInfo describes how to start serving the etcd master", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/legacyconfig/v1.ServingInfo"), }, }, "address": { SchemaProps: spec.SchemaProps{ - Description: "Address is the advertised host:port for client connections to etcd", + Description: "address is the advertised host:port for client connections to etcd", Default: "", Type: []string{"string"}, Format: "", @@ -28230,14 +28233,14 @@ func schema_openshift_api_legacyconfig_v1_EtcdConfig(ref common.ReferenceCallbac }, "peerServingInfo": { SchemaProps: spec.SchemaProps{ - Description: "PeerServingInfo describes how to start serving the etcd peer", + Description: "peerServingInfo describes how to start serving the etcd peer", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/legacyconfig/v1.ServingInfo"), }, }, "peerAddress": { SchemaProps: spec.SchemaProps{ - Description: "PeerAddress is the advertised host:port for peer connections to etcd", + Description: "peerAddress is the advertised host:port for peer connections to etcd", Default: "", Type: []string{"string"}, Format: "", @@ -28269,7 +28272,7 @@ func schema_openshift_api_legacyconfig_v1_EtcdConnectionInfo(ref common.Referenc Properties: map[string]spec.Schema{ "urls": { SchemaProps: spec.SchemaProps{ - Description: "URLs are the URLs for etcd", + Description: "urls are the URLs for etcd", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -28284,7 +28287,7 @@ func schema_openshift_api_legacyconfig_v1_EtcdConnectionInfo(ref common.Referenc }, "ca": { SchemaProps: spec.SchemaProps{ - Description: "CA is a file containing trusted roots for the etcd server certificates", + Description: "ca is a file containing trusted roots for the etcd server certificates", Default: "", Type: []string{"string"}, Format: "", @@ -28292,7 +28295,7 @@ func schema_openshift_api_legacyconfig_v1_EtcdConnectionInfo(ref common.Referenc }, "certFile": { SchemaProps: spec.SchemaProps{ - Description: "CertFile is a file containing a PEM-encoded certificate", + Description: "certFile is a file containing a PEM-encoded certificate", Default: "", Type: []string{"string"}, Format: "", @@ -28300,7 +28303,7 @@ func schema_openshift_api_legacyconfig_v1_EtcdConnectionInfo(ref common.Referenc }, "keyFile": { SchemaProps: spec.SchemaProps{ - Description: "KeyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile", + Description: "keyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile", Default: "", Type: []string{"string"}, Format: "", @@ -28322,7 +28325,7 @@ func schema_openshift_api_legacyconfig_v1_EtcdStorageConfig(ref common.Reference Properties: map[string]spec.Schema{ "kubernetesStorageVersion": { SchemaProps: spec.SchemaProps{ - 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.", + 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.", Default: "", Type: []string{"string"}, Format: "", @@ -28330,7 +28333,7 @@ func schema_openshift_api_legacyconfig_v1_EtcdStorageConfig(ref common.Reference }, "kubernetesStoragePrefix": { SchemaProps: spec.SchemaProps{ - 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'.", + 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'.", Default: "", Type: []string{"string"}, Format: "", @@ -28338,7 +28341,7 @@ func schema_openshift_api_legacyconfig_v1_EtcdStorageConfig(ref common.Reference }, "openShiftStorageVersion": { SchemaProps: spec.SchemaProps{ - 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.", + 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.", Default: "", Type: []string{"string"}, Format: "", @@ -28346,7 +28349,7 @@ func schema_openshift_api_legacyconfig_v1_EtcdStorageConfig(ref common.Reference }, "openShiftStoragePrefix": { SchemaProps: spec.SchemaProps{ - 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'.", + 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'.", Default: "", Type: []string{"string"}, Format: "", @@ -28382,7 +28385,7 @@ func schema_openshift_api_legacyconfig_v1_GitHubIdentityProvider(ref common.Refe }, "clientID": { SchemaProps: spec.SchemaProps{ - Description: "ClientID is the oauth client ID", + Description: "clientID is the oauth client ID", Default: "", Type: []string{"string"}, Format: "", @@ -28390,13 +28393,13 @@ func schema_openshift_api_legacyconfig_v1_GitHubIdentityProvider(ref common.Refe }, "clientSecret": { SchemaProps: spec.SchemaProps{ - Description: "ClientSecret is the oauth client secret", + Description: "clientSecret is the oauth client secret", Ref: ref("github.com/openshift/api/legacyconfig/v1.StringSource"), }, }, "organizations": { SchemaProps: spec.SchemaProps{ - Description: "Organizations optionally restricts which organizations are allowed to log in", + Description: "organizations optionally restricts which organizations are allowed to log in", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -28411,7 +28414,7 @@ func schema_openshift_api_legacyconfig_v1_GitHubIdentityProvider(ref common.Refe }, "teams": { SchemaProps: spec.SchemaProps{ - Description: "Teams optionally restricts which teams are allowed to log in. Format is /.", + Description: "teams optionally restricts which teams are allowed to log in. Format is /.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -28426,7 +28429,7 @@ func schema_openshift_api_legacyconfig_v1_GitHubIdentityProvider(ref common.Refe }, "hostname": { SchemaProps: spec.SchemaProps{ - 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.", + 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.", Default: "", Type: []string{"string"}, Format: "", @@ -28434,7 +28437,7 @@ func schema_openshift_api_legacyconfig_v1_GitHubIdentityProvider(ref common.Refe }, "ca": { SchemaProps: spec.SchemaProps{ - 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.", + 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.", Default: "", Type: []string{"string"}, Format: "", @@ -28472,7 +28475,7 @@ func schema_openshift_api_legacyconfig_v1_GitLabIdentityProvider(ref common.Refe }, "ca": { SchemaProps: spec.SchemaProps{ - 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", + 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", Default: "", Type: []string{"string"}, Format: "", @@ -28480,7 +28483,7 @@ func schema_openshift_api_legacyconfig_v1_GitLabIdentityProvider(ref common.Refe }, "url": { SchemaProps: spec.SchemaProps{ - Description: "URL is the oauth server base URL", + Description: "url is the oauth server base URL", Default: "", Type: []string{"string"}, Format: "", @@ -28488,7 +28491,7 @@ func schema_openshift_api_legacyconfig_v1_GitLabIdentityProvider(ref common.Refe }, "clientID": { SchemaProps: spec.SchemaProps{ - Description: "ClientID is the oauth client ID", + Description: "clientID is the oauth client ID", Default: "", Type: []string{"string"}, Format: "", @@ -28496,13 +28499,13 @@ func schema_openshift_api_legacyconfig_v1_GitLabIdentityProvider(ref common.Refe }, "clientSecret": { SchemaProps: spec.SchemaProps{ - Description: "ClientSecret is the oauth client secret", + Description: "clientSecret is the oauth client secret", Ref: ref("github.com/openshift/api/legacyconfig/v1.StringSource"), }, }, "legacy": { SchemaProps: spec.SchemaProps{ - 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", + 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: []string{"boolean"}, Format: "", }, @@ -28539,7 +28542,7 @@ func schema_openshift_api_legacyconfig_v1_GoogleIdentityProvider(ref common.Refe }, "clientID": { SchemaProps: spec.SchemaProps{ - Description: "ClientID is the oauth client ID", + Description: "clientID is the oauth client ID", Default: "", Type: []string{"string"}, Format: "", @@ -28547,13 +28550,13 @@ func schema_openshift_api_legacyconfig_v1_GoogleIdentityProvider(ref common.Refe }, "clientSecret": { SchemaProps: spec.SchemaProps{ - Description: "ClientSecret is the oauth client secret", + Description: "clientSecret is the oauth client secret", Ref: ref("github.com/openshift/api/legacyconfig/v1.StringSource"), }, }, "hostedDomain": { SchemaProps: spec.SchemaProps{ - Description: "HostedDomain is the optional Google App domain (e.g. \"mycompany.com\") to restrict logins to", + Description: "hostedDomain is the optional Google App domain (e.g. \"mycompany.com\") to restrict logins to", Default: "", Type: []string{"string"}, Format: "", @@ -28577,7 +28580,7 @@ func schema_openshift_api_legacyconfig_v1_GrantConfig(ref common.ReferenceCallba Properties: map[string]spec.Schema{ "method": { SchemaProps: spec.SchemaProps{ - 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", + 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", Default: "", Type: []string{"string"}, Format: "", @@ -28585,7 +28588,7 @@ func schema_openshift_api_legacyconfig_v1_GrantConfig(ref common.ReferenceCallba }, "serviceAccountMethod": { SchemaProps: spec.SchemaProps{ - Description: "ServiceAccountMethod is used for determining client authorization for service account oauth client. It must be either: deny, prompt", + Description: "serviceAccountMethod is used for determining client authorization for service account oauth client. It must be either: deny, prompt", Default: "", Type: []string{"string"}, Format: "", @@ -28607,7 +28610,7 @@ func schema_openshift_api_legacyconfig_v1_GroupResource(ref common.ReferenceCall Properties: map[string]spec.Schema{ "group": { SchemaProps: spec.SchemaProps{ - Description: "Group is the name of an API group", + Description: "group is the name of an API group", Default: "", Type: []string{"string"}, Format: "", @@ -28615,7 +28618,7 @@ func schema_openshift_api_legacyconfig_v1_GroupResource(ref common.ReferenceCall }, "resource": { SchemaProps: spec.SchemaProps{ - Description: "Resource is the name of a resource.", + Description: "resource is the name of a resource.", Default: "", Type: []string{"string"}, Format: "", @@ -28651,7 +28654,7 @@ func schema_openshift_api_legacyconfig_v1_HTPasswdPasswordIdentityProvider(ref c }, "file": { SchemaProps: spec.SchemaProps{ - Description: "File is a reference to your htpasswd file", + Description: "file is a reference to your htpasswd file", Default: "", Type: []string{"string"}, Format: "", @@ -28673,7 +28676,7 @@ func schema_openshift_api_legacyconfig_v1_HTTPServingInfo(ref common.ReferenceCa Properties: map[string]spec.Schema{ "bindAddress": { SchemaProps: spec.SchemaProps{ - Description: "BindAddress is the ip:port to serve on", + Description: "bindAddress is the ip:port to serve on", Default: "", Type: []string{"string"}, Format: "", @@ -28681,7 +28684,7 @@ func schema_openshift_api_legacyconfig_v1_HTTPServingInfo(ref common.ReferenceCa }, "bindNetwork": { SchemaProps: spec.SchemaProps{ - Description: "BindNetwork is the type of network to bind to - defaults to \"tcp4\", accepts \"tcp\", \"tcp4\", and \"tcp6\"", + Description: "bindNetwork is the type of network to bind to - defaults to \"tcp4\", accepts \"tcp\", \"tcp4\", and \"tcp6\"", Default: "", Type: []string{"string"}, Format: "", @@ -28689,7 +28692,7 @@ func schema_openshift_api_legacyconfig_v1_HTTPServingInfo(ref common.ReferenceCa }, "certFile": { SchemaProps: spec.SchemaProps{ - Description: "CertFile is a file containing a PEM-encoded certificate", + Description: "certFile is a file containing a PEM-encoded certificate", Default: "", Type: []string{"string"}, Format: "", @@ -28697,7 +28700,7 @@ func schema_openshift_api_legacyconfig_v1_HTTPServingInfo(ref common.ReferenceCa }, "keyFile": { SchemaProps: spec.SchemaProps{ - Description: "KeyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile", + Description: "keyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile", Default: "", Type: []string{"string"}, Format: "", @@ -28705,7 +28708,7 @@ func schema_openshift_api_legacyconfig_v1_HTTPServingInfo(ref common.ReferenceCa }, "clientCA": { SchemaProps: spec.SchemaProps{ - Description: "ClientCA is the certificate bundle for all the signers that you'll recognize for incoming client certificates", + Description: "clientCA is the certificate bundle for all the signers that you'll recognize for incoming client certificates", Default: "", Type: []string{"string"}, Format: "", @@ -28713,7 +28716,7 @@ func schema_openshift_api_legacyconfig_v1_HTTPServingInfo(ref common.ReferenceCa }, "namedCertificates": { SchemaProps: spec.SchemaProps{ - Description: "NamedCertificates is a list of certificates to use to secure requests to specific hostnames", + Description: "namedCertificates is a list of certificates to use to secure requests to specific hostnames", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -28727,14 +28730,14 @@ func schema_openshift_api_legacyconfig_v1_HTTPServingInfo(ref common.ReferenceCa }, "minTLSVersion": { SchemaProps: spec.SchemaProps{ - Description: "MinTLSVersion is the minimum TLS version supported. Values must match version names from https://golang.org/pkg/crypto/tls/#pkg-constants", + Description: "minTLSVersion is the minimum TLS version supported. Values must match version names from https://golang.org/pkg/crypto/tls/#pkg-constants", Type: []string{"string"}, Format: "", }, }, "cipherSuites": { SchemaProps: spec.SchemaProps{ - 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", + 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: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -28749,7 +28752,7 @@ func schema_openshift_api_legacyconfig_v1_HTTPServingInfo(ref common.ReferenceCa }, "maxRequestsInFlight": { SchemaProps: spec.SchemaProps{ - Description: "MaxRequestsInFlight is the number of concurrent requests allowed to the server. If zero, no limit.", + Description: "maxRequestsInFlight is the number of concurrent requests allowed to the server. If zero, no limit.", Default: 0, Type: []string{"integer"}, Format: "int32", @@ -28757,7 +28760,7 @@ func schema_openshift_api_legacyconfig_v1_HTTPServingInfo(ref common.ReferenceCa }, "requestTimeoutSeconds": { SchemaProps: spec.SchemaProps{ - 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.", + 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.", Default: 0, Type: []string{"integer"}, Format: "int32", @@ -28781,7 +28784,7 @@ func schema_openshift_api_legacyconfig_v1_IdentityProvider(ref common.ReferenceC Properties: map[string]spec.Schema{ "name": { SchemaProps: spec.SchemaProps{ - Description: "Name is used to qualify the identities returned by this provider", + Description: "name is used to qualify the identities returned by this provider", Default: "", Type: []string{"string"}, Format: "", @@ -28805,7 +28808,7 @@ func schema_openshift_api_legacyconfig_v1_IdentityProvider(ref common.ReferenceC }, "mappingMethod": { SchemaProps: spec.SchemaProps{ - Description: "MappingMethod determines how identities from this provider are mapped to users", + Description: "mappingMethod determines how identities from this provider are mapped to users", Default: "", Type: []string{"string"}, Format: "", @@ -28813,7 +28816,7 @@ func schema_openshift_api_legacyconfig_v1_IdentityProvider(ref common.ReferenceC }, "provider": { SchemaProps: spec.SchemaProps{ - Description: "Provider contains the information about how to set up a specific identity provider", + Description: "provider contains the information about how to set up a specific identity provider", Ref: ref("k8s.io/apimachinery/pkg/runtime.RawExtension"), }, }, @@ -28835,7 +28838,7 @@ func schema_openshift_api_legacyconfig_v1_ImageConfig(ref common.ReferenceCallba Properties: map[string]spec.Schema{ "format": { SchemaProps: spec.SchemaProps{ - Description: "Format is the format of the name to be built for the system component", + Description: "format is the format of the name to be built for the system component", Default: "", Type: []string{"string"}, Format: "", @@ -28843,7 +28846,7 @@ func schema_openshift_api_legacyconfig_v1_ImageConfig(ref common.ReferenceCallba }, "latest": { SchemaProps: spec.SchemaProps{ - Description: "Latest determines if the latest tag will be pulled from the registry", + Description: "latest determines if the latest tag will be pulled from the registry", Default: false, Type: []string{"boolean"}, Format: "", @@ -28865,7 +28868,7 @@ func schema_openshift_api_legacyconfig_v1_ImagePolicyConfig(ref common.Reference Properties: map[string]spec.Schema{ "maxImagesBulkImportedPerRepository": { SchemaProps: spec.SchemaProps{ - 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.", + 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.", Default: 0, Type: []string{"integer"}, Format: "int32", @@ -28873,7 +28876,7 @@ func schema_openshift_api_legacyconfig_v1_ImagePolicyConfig(ref common.Reference }, "disableScheduledImport": { SchemaProps: spec.SchemaProps{ - Description: "DisableScheduledImport allows scheduled background import of images to be disabled.", + Description: "disableScheduledImport allows scheduled background import of images to be disabled.", Default: false, Type: []string{"boolean"}, Format: "", @@ -28881,7 +28884,7 @@ func schema_openshift_api_legacyconfig_v1_ImagePolicyConfig(ref common.Reference }, "scheduledImageImportMinimumIntervalSeconds": { SchemaProps: spec.SchemaProps{ - 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.", + 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.", Default: 0, Type: []string{"integer"}, Format: "int32", @@ -28889,7 +28892,7 @@ func schema_openshift_api_legacyconfig_v1_ImagePolicyConfig(ref common.Reference }, "maxScheduledImageImportsPerMinute": { SchemaProps: spec.SchemaProps{ - 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.", + 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.", Default: 0, Type: []string{"integer"}, Format: "int32", @@ -28897,7 +28900,7 @@ func schema_openshift_api_legacyconfig_v1_ImagePolicyConfig(ref common.Reference }, "allowedRegistriesForImport": { SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -28911,21 +28914,21 @@ func schema_openshift_api_legacyconfig_v1_ImagePolicyConfig(ref common.Reference }, "internalRegistryHostname": { SchemaProps: spec.SchemaProps{ - Description: "InternalRegistryHostname sets the hostname for the default internal image registry. The value must be in \"hostname[:port]\" format.", + Description: "internalRegistryHostname sets the hostname for the default internal image registry. The value must be in \"hostname[:port]\" format.", Type: []string{"string"}, Format: "", }, }, "externalRegistryHostname": { SchemaProps: spec.SchemaProps{ - 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.", + 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{"string"}, Format: "", }, }, "additionalTrustedCA": { SchemaProps: spec.SchemaProps{ - Description: "AdditionalTrustedCA is a path to a pem bundle file containing additional CAs that should be trusted during imagestream import.", + Description: "additionalTrustedCA is a path to a pem bundle file containing additional CAs that should be trusted during imagestream import.", Type: []string{"string"}, Format: "", }, @@ -28948,14 +28951,14 @@ func schema_openshift_api_legacyconfig_v1_JenkinsPipelineConfig(ref common.Refer Properties: map[string]spec.Schema{ "autoProvisionEnabled": { SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"boolean"}, Format: "", }, }, "templateNamespace": { SchemaProps: spec.SchemaProps{ - Description: "TemplateNamespace contains the namespace name where the Jenkins template is stored", + Description: "templateNamespace contains the namespace name where the Jenkins template is stored", Default: "", Type: []string{"string"}, Format: "", @@ -28963,7 +28966,7 @@ func schema_openshift_api_legacyconfig_v1_JenkinsPipelineConfig(ref common.Refer }, "templateName": { SchemaProps: spec.SchemaProps{ - Description: "TemplateName is the name of the default Jenkins template", + Description: "templateName is the name of the default Jenkins template", Default: "", Type: []string{"string"}, Format: "", @@ -28971,7 +28974,7 @@ func schema_openshift_api_legacyconfig_v1_JenkinsPipelineConfig(ref common.Refer }, "serviceName": { SchemaProps: spec.SchemaProps{ - 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.", + 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.", Default: "", Type: []string{"string"}, Format: "", @@ -28979,7 +28982,7 @@ func schema_openshift_api_legacyconfig_v1_JenkinsPipelineConfig(ref common.Refer }, "parameters": { SchemaProps: spec.SchemaProps{ - Description: "Parameters specifies a set of optional parameters to the Jenkins template.", + Description: "parameters specifies a set of optional parameters to the Jenkins template.", Type: []string{"object"}, AdditionalProperties: &spec.SchemaOrBool{ Allows: true, @@ -29023,7 +29026,7 @@ func schema_openshift_api_legacyconfig_v1_KeystonePasswordIdentityProvider(ref c }, "url": { SchemaProps: spec.SchemaProps{ - Description: "URL is the remote URL to connect to", + Description: "url is the remote URL to connect to", Default: "", Type: []string{"string"}, Format: "", @@ -29031,7 +29034,7 @@ func schema_openshift_api_legacyconfig_v1_KeystonePasswordIdentityProvider(ref c }, "ca": { SchemaProps: spec.SchemaProps{ - Description: "CA is the CA for verifying TLS connections", + Description: "ca is the CA for verifying TLS connections", Default: "", Type: []string{"string"}, Format: "", @@ -29039,7 +29042,7 @@ func schema_openshift_api_legacyconfig_v1_KeystonePasswordIdentityProvider(ref c }, "certFile": { SchemaProps: spec.SchemaProps{ - Description: "CertFile is a file containing a PEM-encoded certificate", + Description: "certFile is a file containing a PEM-encoded certificate", Default: "", Type: []string{"string"}, Format: "", @@ -29047,7 +29050,7 @@ func schema_openshift_api_legacyconfig_v1_KeystonePasswordIdentityProvider(ref c }, "keyFile": { SchemaProps: spec.SchemaProps{ - Description: "KeyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile", + Description: "keyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile", Default: "", Type: []string{"string"}, Format: "", @@ -29063,7 +29066,7 @@ func schema_openshift_api_legacyconfig_v1_KeystonePasswordIdentityProvider(ref c }, "useKeystoneIdentity": { SchemaProps: spec.SchemaProps{ - Description: "UseKeystoneIdentity flag indicates that user should be authenticated by keystone ID, not by username", + Description: "useKeystoneIdentity flag indicates that user should be authenticated by keystone ID, not by username", Default: false, Type: []string{"boolean"}, Format: "", @@ -29085,7 +29088,7 @@ func schema_openshift_api_legacyconfig_v1_KubeletConnectionInfo(ref common.Refer Properties: map[string]spec.Schema{ "port": { SchemaProps: spec.SchemaProps{ - Description: "Port is the port to connect to kubelets on", + Description: "port is the port to connect to kubelets on", Default: 0, Type: []string{"integer"}, Format: "int32", @@ -29093,7 +29096,7 @@ func schema_openshift_api_legacyconfig_v1_KubeletConnectionInfo(ref common.Refer }, "ca": { SchemaProps: spec.SchemaProps{ - Description: "CA is the CA for verifying TLS connections to kubelets", + Description: "ca is the CA for verifying TLS connections to kubelets", Default: "", Type: []string{"string"}, Format: "", @@ -29101,7 +29104,7 @@ func schema_openshift_api_legacyconfig_v1_KubeletConnectionInfo(ref common.Refer }, "certFile": { SchemaProps: spec.SchemaProps{ - Description: "CertFile is a file containing a PEM-encoded certificate", + Description: "certFile is a file containing a PEM-encoded certificate", Default: "", Type: []string{"string"}, Format: "", @@ -29109,7 +29112,7 @@ func schema_openshift_api_legacyconfig_v1_KubeletConnectionInfo(ref common.Refer }, "keyFile": { SchemaProps: spec.SchemaProps{ - Description: "KeyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile", + Description: "keyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile", Default: "", Type: []string{"string"}, Format: "", @@ -29131,7 +29134,7 @@ func schema_openshift_api_legacyconfig_v1_KubernetesMasterConfig(ref common.Refe Properties: map[string]spec.Schema{ "apiLevels": { SchemaProps: spec.SchemaProps{ - Description: "APILevels is a list of API levels that should be enabled on startup: v1 as examples", + Description: "apiLevels is a list of API levels that should be enabled on startup: v1 as examples", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -29146,7 +29149,7 @@ func schema_openshift_api_legacyconfig_v1_KubernetesMasterConfig(ref common.Refe }, "disabledAPIGroupVersions": { SchemaProps: spec.SchemaProps{ - Description: "DisabledAPIGroupVersions is a map of groups to the versions (or *) that should be disabled.", + Description: "disabledAPIGroupVersions is a map of groups to the versions (or *) that should be disabled.", Type: []string{"object"}, AdditionalProperties: &spec.SchemaOrBool{ Allows: true, @@ -29169,7 +29172,7 @@ func schema_openshift_api_legacyconfig_v1_KubernetesMasterConfig(ref common.Refe }, "masterIP": { SchemaProps: spec.SchemaProps{ - Description: "MasterIP is the public IP address of kubernetes stuff. If empty, the first result from net.InterfaceAddrs will be used.", + Description: "masterIP is the public IP address of kubernetes stuff. If empty, the first result from net.InterfaceAddrs will be used.", Default: "", Type: []string{"string"}, Format: "", @@ -29177,7 +29180,7 @@ func schema_openshift_api_legacyconfig_v1_KubernetesMasterConfig(ref common.Refe }, "masterEndpointReconcileTTL": { SchemaProps: spec.SchemaProps{ - 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.", + 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.", Default: 0, Type: []string{"integer"}, Format: "int32", @@ -29185,7 +29188,7 @@ func schema_openshift_api_legacyconfig_v1_KubernetesMasterConfig(ref common.Refe }, "servicesSubnet": { SchemaProps: spec.SchemaProps{ - Description: "ServicesSubnet is the subnet to use for assigning service IPs", + Description: "servicesSubnet is the subnet to use for assigning service IPs", Default: "", Type: []string{"string"}, Format: "", @@ -29193,7 +29196,7 @@ func schema_openshift_api_legacyconfig_v1_KubernetesMasterConfig(ref common.Refe }, "servicesNodePortRange": { SchemaProps: spec.SchemaProps{ - Description: "ServicesNodePortRange is the range to use for assigning service public ports on a host.", + Description: "servicesNodePortRange is the range to use for assigning service public ports on a host.", Default: "", Type: []string{"string"}, Format: "", @@ -29201,7 +29204,7 @@ func schema_openshift_api_legacyconfig_v1_KubernetesMasterConfig(ref common.Refe }, "schedulerConfigFile": { SchemaProps: spec.SchemaProps{ - Description: "SchedulerConfigFile points to a file that describes how to set up the scheduler. If empty, you get the default scheduling rules.", + Description: "schedulerConfigFile points to a file that describes how to set up the scheduler. If empty, you get the default scheduling rules.", Default: "", Type: []string{"string"}, Format: "", @@ -29209,7 +29212,7 @@ func schema_openshift_api_legacyconfig_v1_KubernetesMasterConfig(ref common.Refe }, "podEvictionTimeout": { SchemaProps: spec.SchemaProps{ - 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.", + 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.", Default: "", Type: []string{"string"}, Format: "", @@ -29217,14 +29220,14 @@ func schema_openshift_api_legacyconfig_v1_KubernetesMasterConfig(ref common.Refe }, "proxyClientInfo": { SchemaProps: spec.SchemaProps{ - Description: "ProxyClientInfo specifies the client cert/key to use when proxying to pods", + Description: "proxyClientInfo specifies the client cert/key to use when proxying to pods", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/legacyconfig/v1.CertInfo"), }, }, "apiServerArguments": { SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"object"}, AdditionalProperties: &spec.SchemaOrBool{ Allows: true, @@ -29247,7 +29250,7 @@ func schema_openshift_api_legacyconfig_v1_KubernetesMasterConfig(ref common.Refe }, "controllerArguments": { SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"object"}, AdditionalProperties: &spec.SchemaOrBool{ Allows: true, @@ -29270,7 +29273,7 @@ func schema_openshift_api_legacyconfig_v1_KubernetesMasterConfig(ref common.Refe }, "schedulerArguments": { SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"object"}, AdditionalProperties: &spec.SchemaOrBool{ Allows: true, @@ -29309,7 +29312,7 @@ func schema_openshift_api_legacyconfig_v1_LDAPAttributeMapping(ref common.Refere Properties: map[string]spec.Schema{ "id": { SchemaProps: spec.SchemaProps{ - 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. LDAP standard identity attribute is \"dn\"", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -29324,7 +29327,7 @@ func schema_openshift_api_legacyconfig_v1_LDAPAttributeMapping(ref common.Refere }, "preferredUsername": { SchemaProps: spec.SchemaProps{ - Description: "PreferredUsername is the list of attributes whose values should be used as the preferred username. LDAP standard login attribute is \"uid\"", + Description: "preferredUsername is the list of attributes whose values should be used as the preferred username. LDAP standard login attribute is \"uid\"", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -29339,7 +29342,7 @@ func schema_openshift_api_legacyconfig_v1_LDAPAttributeMapping(ref common.Refere }, "name": { SchemaProps: spec.SchemaProps{ - 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\"", + 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: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -29354,7 +29357,7 @@ func schema_openshift_api_legacyconfig_v1_LDAPAttributeMapping(ref common.Refere }, "email": { SchemaProps: spec.SchemaProps{ - 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", + 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: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -29397,7 +29400,7 @@ func schema_openshift_api_legacyconfig_v1_LDAPPasswordIdentityProvider(ref commo }, "url": { SchemaProps: spec.SchemaProps{ - 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\n ldap://host:port/basedn?attribute?scope?filter", Default: "", Type: []string{"string"}, Format: "", @@ -29405,7 +29408,7 @@ func schema_openshift_api_legacyconfig_v1_LDAPPasswordIdentityProvider(ref commo }, "bindDN": { SchemaProps: spec.SchemaProps{ - Description: "BindDN is an optional DN to bind with during the search phase.", + Description: "bindDN is an optional DN to bind with during the search phase.", Default: "", Type: []string{"string"}, Format: "", @@ -29413,7 +29416,7 @@ func schema_openshift_api_legacyconfig_v1_LDAPPasswordIdentityProvider(ref commo }, "bindPassword": { SchemaProps: spec.SchemaProps{ - Description: "BindPassword is an optional password to bind with during the search phase.", + Description: "bindPassword is an optional password to bind with during the search phase.", Ref: ref("github.com/openshift/api/legacyconfig/v1.StringSource"), }, }, @@ -29427,7 +29430,7 @@ func schema_openshift_api_legacyconfig_v1_LDAPPasswordIdentityProvider(ref commo }, "ca": { SchemaProps: spec.SchemaProps{ - 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", + 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", Default: "", Type: []string{"string"}, Format: "", @@ -29435,7 +29438,7 @@ func schema_openshift_api_legacyconfig_v1_LDAPPasswordIdentityProvider(ref commo }, "attributes": { SchemaProps: spec.SchemaProps{ - Description: "Attributes maps LDAP attributes to identities", + Description: "attributes maps LDAP attributes to identities", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/legacyconfig/v1.LDAPAttributeMapping"), }, @@ -29490,7 +29493,7 @@ func schema_openshift_api_legacyconfig_v1_LDAPQuery(ref common.ReferenceCallback }, "filter": { SchemaProps: spec.SchemaProps{ - Description: "Filter is a valid LDAP search filter that retrieves all relevant entries from the LDAP server with the base DN", + Description: "filter is a valid LDAP search filter that retrieves all relevant entries from the LDAP server with the base DN", Default: "", Type: []string{"string"}, Format: "", @@ -29498,7 +29501,7 @@ func schema_openshift_api_legacyconfig_v1_LDAPQuery(ref common.ReferenceCallback }, "pageSize": { SchemaProps: spec.SchemaProps{ - Description: "PageSize is the maximum preferred page size, measured in LDAP entries. A page size of 0 means no paging will be done.", + Description: "pageSize is the maximum preferred page size, measured in LDAP entries. A page size of 0 means no paging will be done.", Default: 0, Type: []string{"integer"}, Format: "int32", @@ -29542,7 +29545,7 @@ func schema_openshift_api_legacyconfig_v1_LDAPSyncConfig(ref common.ReferenceCal }, "bindDN": { SchemaProps: spec.SchemaProps{ - Description: "BindDN is an optional DN to bind to the LDAP server with", + Description: "bindDN is an optional DN to bind to the LDAP server with", Default: "", Type: []string{"string"}, Format: "", @@ -29550,7 +29553,7 @@ func schema_openshift_api_legacyconfig_v1_LDAPSyncConfig(ref common.ReferenceCal }, "bindPassword": { SchemaProps: spec.SchemaProps{ - Description: "BindPassword is an optional password to bind with during the search phase.", + Description: "bindPassword is an optional password to bind with during the search phase.", Ref: ref("github.com/openshift/api/legacyconfig/v1.StringSource"), }, }, @@ -29564,7 +29567,7 @@ func schema_openshift_api_legacyconfig_v1_LDAPSyncConfig(ref common.ReferenceCal }, "ca": { SchemaProps: spec.SchemaProps{ - 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", + 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", Default: "", Type: []string{"string"}, Format: "", @@ -29644,7 +29647,7 @@ func schema_openshift_api_legacyconfig_v1_MasterAuthConfig(ref common.ReferenceC Properties: map[string]spec.Schema{ "requestHeader": { SchemaProps: spec.SchemaProps{ - Description: "RequestHeader holds options for setting up a front proxy against the API. It is optional.", + Description: "requestHeader holds options for setting up a front proxy against the API. It is optional.", Ref: ref("github.com/openshift/api/legacyconfig/v1.RequestHeaderAuthenticationOptions"), }, }, @@ -29664,7 +29667,7 @@ func schema_openshift_api_legacyconfig_v1_MasterAuthConfig(ref common.ReferenceC }, "oauthMetadataFile": { SchemaProps: spec.SchemaProps{ - 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", + 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", Default: "", Type: []string{"string"}, Format: "", @@ -29688,7 +29691,7 @@ func schema_openshift_api_legacyconfig_v1_MasterClients(ref common.ReferenceCall Properties: map[string]spec.Schema{ "openshiftLoopbackKubeConfig": { SchemaProps: spec.SchemaProps{ - Description: "OpenShiftLoopbackKubeConfig is a .kubeconfig filename for system components to loopback to this master", + Description: "openshiftLoopbackKubeConfig is a .kubeconfig filename for system components to loopback to this master", Default: "", Type: []string{"string"}, Format: "", @@ -29696,7 +29699,7 @@ func schema_openshift_api_legacyconfig_v1_MasterClients(ref common.ReferenceCall }, "openshiftLoopbackClientConnectionOverrides": { SchemaProps: spec.SchemaProps{ - Description: "OpenShiftLoopbackClientConnectionOverrides specifies client overrides for system components to loop back to this master.", + Description: "openshiftLoopbackClientConnectionOverrides specifies client overrides for system components to loop back to this master.", Ref: ref("github.com/openshift/api/legacyconfig/v1.ClientConnectionOverrides"), }, }, @@ -29732,21 +29735,21 @@ func schema_openshift_api_legacyconfig_v1_MasterConfig(ref common.ReferenceCallb }, "servingInfo": { SchemaProps: spec.SchemaProps{ - Description: "ServingInfo describes how to start serving", + Description: "servingInfo describes how to start serving", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/legacyconfig/v1.HTTPServingInfo"), }, }, "authConfig": { SchemaProps: spec.SchemaProps{ - Description: "AuthConfig configures authentication options in addition to the standard oauth token and client certificate authenticators", + Description: "authConfig configures authentication options in addition to the standard oauth token and client certificate authenticators", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/legacyconfig/v1.MasterAuthConfig"), }, }, "aggregatorConfig": { SchemaProps: spec.SchemaProps{ - Description: "AggregatorConfig has options for configuring the aggregator component of the API server.", + Description: "aggregatorConfig has options for configuring the aggregator component of the API server.", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/legacyconfig/v1.AggregatorConfig"), }, @@ -29768,7 +29771,7 @@ func schema_openshift_api_legacyconfig_v1_MasterConfig(ref common.ReferenceCallb }, "apiLevels": { SchemaProps: spec.SchemaProps{ - Description: "APILevels is a list of API levels that should be enabled on startup: v1 as examples", + Description: "apiLevels is a list of API levels that should be enabled on startup: v1 as examples", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -29783,7 +29786,7 @@ func schema_openshift_api_legacyconfig_v1_MasterConfig(ref common.ReferenceCallb }, "masterPublicURL": { SchemaProps: spec.SchemaProps{ - Description: "MasterPublicURL is how clients can access the OpenShift API server", + Description: "masterPublicURL is how clients can access the OpenShift API server", Default: "", Type: []string{"string"}, Format: "", @@ -29791,7 +29794,7 @@ func schema_openshift_api_legacyconfig_v1_MasterConfig(ref common.ReferenceCallb }, "controllers": { SchemaProps: spec.SchemaProps{ - 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.", + 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.", Default: "", Type: []string{"string"}, Format: "", @@ -29799,35 +29802,35 @@ func schema_openshift_api_legacyconfig_v1_MasterConfig(ref common.ReferenceCallb }, "admissionConfig": { SchemaProps: spec.SchemaProps{ - Description: "AdmissionConfig contains admission control plugin configuration.", + Description: "admissionConfig contains admission control plugin configuration.", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/legacyconfig/v1.AdmissionConfig"), }, }, "controllerConfig": { SchemaProps: spec.SchemaProps{ - Description: "ControllerConfig holds configuration values for controllers", + Description: "controllerConfig holds configuration values for controllers", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/legacyconfig/v1.ControllerConfig"), }, }, "etcdStorageConfig": { SchemaProps: spec.SchemaProps{ - 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.", + 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: map[string]interface{}{}, Ref: ref("github.com/openshift/api/legacyconfig/v1.EtcdStorageConfig"), }, }, "etcdClientInfo": { SchemaProps: spec.SchemaProps{ - Description: "EtcdClientInfo contains information about how to connect to etcd", + Description: "etcdClientInfo contains information about how to connect to etcd", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/legacyconfig/v1.EtcdConnectionInfo"), }, }, "kubeletClientInfo": { SchemaProps: spec.SchemaProps{ - Description: "KubeletClientInfo contains information about how to connect to kubelets", + Description: "kubeletClientInfo contains information about how to connect to kubelets", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/legacyconfig/v1.KubeletConnectionInfo"), }, @@ -29859,56 +29862,56 @@ func schema_openshift_api_legacyconfig_v1_MasterConfig(ref common.ReferenceCallb }, "serviceAccountConfig": { SchemaProps: spec.SchemaProps{ - Description: "ServiceAccountConfig holds options related to service accounts", + Description: "serviceAccountConfig holds options related to service accounts", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/legacyconfig/v1.ServiceAccountConfig"), }, }, "masterClients": { SchemaProps: spec.SchemaProps{ - Description: "MasterClients holds all the client connection information for controllers and other system components", + Description: "masterClients holds all the client connection information for controllers and other system components", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/legacyconfig/v1.MasterClients"), }, }, "imageConfig": { SchemaProps: spec.SchemaProps{ - Description: "ImageConfig holds options that describe how to build image names for system components", + Description: "imageConfig holds options that describe how to build image names for system components", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/legacyconfig/v1.ImageConfig"), }, }, "imagePolicyConfig": { SchemaProps: spec.SchemaProps{ - Description: "ImagePolicyConfig controls limits and behavior for importing images", + Description: "imagePolicyConfig controls limits and behavior for importing images", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/legacyconfig/v1.ImagePolicyConfig"), }, }, "policyConfig": { SchemaProps: spec.SchemaProps{ - Description: "PolicyConfig holds information about where to locate critical pieces of bootstrapping policy", + Description: "policyConfig holds information about where to locate critical pieces of bootstrapping policy", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/legacyconfig/v1.PolicyConfig"), }, }, "projectConfig": { SchemaProps: spec.SchemaProps{ - Description: "ProjectConfig holds information about project creation and defaults", + Description: "projectConfig holds information about project creation and defaults", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/legacyconfig/v1.ProjectConfig"), }, }, "routingConfig": { SchemaProps: spec.SchemaProps{ - Description: "RoutingConfig holds information about routing and route generation", + Description: "routingConfig holds information about routing and route generation", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/legacyconfig/v1.RoutingConfig"), }, }, "networkConfig": { SchemaProps: spec.SchemaProps{ - Description: "NetworkConfig to be passed to the compiled in network plugin", + Description: "networkConfig to be passed to the compiled in network plugin", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/legacyconfig/v1.MasterNetworkConfig"), }, @@ -29922,14 +29925,14 @@ func schema_openshift_api_legacyconfig_v1_MasterConfig(ref common.ReferenceCallb }, "jenkinsPipelineConfig": { SchemaProps: spec.SchemaProps{ - Description: "JenkinsPipelineConfig holds information about the default Jenkins template used for JenkinsPipeline build strategy.", + Description: "jenkinsPipelineConfig holds information about the default Jenkins template used for JenkinsPipeline build strategy.", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/legacyconfig/v1.JenkinsPipelineConfig"), }, }, "auditConfig": { SchemaProps: spec.SchemaProps{ - Description: "AuditConfig holds information related to auditing capabilities.", + Description: "auditConfig holds information related to auditing capabilities.", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/legacyconfig/v1.AuditConfig"), }, @@ -29952,7 +29955,7 @@ func schema_openshift_api_legacyconfig_v1_MasterNetworkConfig(ref common.Referen Properties: map[string]spec.Schema{ "networkPluginName": { SchemaProps: spec.SchemaProps{ - Description: "NetworkPluginName is the name of the network plugin to use", + Description: "networkPluginName is the name of the network plugin to use", Default: "", Type: []string{"string"}, Format: "", @@ -29960,14 +29963,14 @@ func schema_openshift_api_legacyconfig_v1_MasterNetworkConfig(ref common.Referen }, "clusterNetworkCIDR": { SchemaProps: spec.SchemaProps{ - Description: "ClusterNetworkCIDR is the CIDR string to specify the global overlay network's L3 space. Deprecated, but maintained for backwards compatibility, use ClusterNetworks instead.", + 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{"string"}, Format: "", }, }, "clusterNetworks": { SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -29981,7 +29984,7 @@ func schema_openshift_api_legacyconfig_v1_MasterNetworkConfig(ref common.Referen }, "hostSubnetLength": { SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"integer"}, Format: "int64", }, @@ -29996,7 +29999,7 @@ func schema_openshift_api_legacyconfig_v1_MasterNetworkConfig(ref common.Referen }, "externalIPNetworkCIDRs": { SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -30011,7 +30014,7 @@ func schema_openshift_api_legacyconfig_v1_MasterNetworkConfig(ref common.Referen }, "ingressIPNetworkCIDR": { SchemaProps: spec.SchemaProps{ - 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.", + 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.", Default: "", Type: []string{"string"}, Format: "", @@ -30019,7 +30022,7 @@ func schema_openshift_api_legacyconfig_v1_MasterNetworkConfig(ref common.Referen }, "vxlanPort": { SchemaProps: spec.SchemaProps{ - Description: "VXLANPort is the VXLAN port used by the cluster defaults. If it is not set, 4789 is the default value", + Description: "vxlanPort is the VXLAN port used by the cluster defaults. If it is not set, 4789 is the default value", Type: []string{"integer"}, Format: "int64", }, @@ -30042,7 +30045,7 @@ func schema_openshift_api_legacyconfig_v1_MasterVolumeConfig(ref common.Referenc Properties: map[string]spec.Schema{ "dynamicProvisioningEnabled": { SchemaProps: spec.SchemaProps{ - Description: "DynamicProvisioningEnabled is a boolean that toggles dynamic provisioning off when false, defaults to true", + Description: "dynamicProvisioningEnabled is a boolean that toggles dynamic provisioning off when false, defaults to true", Type: []string{"boolean"}, Format: "", }, @@ -30063,7 +30066,7 @@ func schema_openshift_api_legacyconfig_v1_NamedCertificate(ref common.ReferenceC Properties: map[string]spec.Schema{ "names": { SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -30078,7 +30081,7 @@ func schema_openshift_api_legacyconfig_v1_NamedCertificate(ref common.ReferenceC }, "certFile": { SchemaProps: spec.SchemaProps{ - Description: "CertFile is a file containing a PEM-encoded certificate", + Description: "certFile is a file containing a PEM-encoded certificate", Default: "", Type: []string{"string"}, Format: "", @@ -30086,7 +30089,7 @@ func schema_openshift_api_legacyconfig_v1_NamedCertificate(ref common.ReferenceC }, "keyFile": { SchemaProps: spec.SchemaProps{ - Description: "KeyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile", + Description: "keyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile", Default: "", Type: []string{"string"}, Format: "", @@ -30108,7 +30111,7 @@ func schema_openshift_api_legacyconfig_v1_NodeAuthConfig(ref common.ReferenceCal Properties: map[string]spec.Schema{ "authenticationCacheTTL": { SchemaProps: spec.SchemaProps{ - 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", + 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", Default: "", Type: []string{"string"}, Format: "", @@ -30116,7 +30119,7 @@ func schema_openshift_api_legacyconfig_v1_NodeAuthConfig(ref common.ReferenceCal }, "authenticationCacheSize": { SchemaProps: spec.SchemaProps{ - Description: "AuthenticationCacheSize indicates how many authentication results should be cached. If 0, the default cache size is used.", + Description: "authenticationCacheSize indicates how many authentication results should be cached. If 0, the default cache size is used.", Default: 0, Type: []string{"integer"}, Format: "int32", @@ -30124,7 +30127,7 @@ func schema_openshift_api_legacyconfig_v1_NodeAuthConfig(ref common.ReferenceCal }, "authorizationCacheTTL": { SchemaProps: spec.SchemaProps{ - 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", + 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", Default: "", Type: []string{"string"}, Format: "", @@ -30132,7 +30135,7 @@ func schema_openshift_api_legacyconfig_v1_NodeAuthConfig(ref common.ReferenceCal }, "authorizationCacheSize": { SchemaProps: spec.SchemaProps{ - Description: "AuthorizationCacheSize indicates how many authorization results should be cached. If 0, the default cache size is used.", + Description: "authorizationCacheSize indicates how many authorization results should be cached. If 0, the default cache size is used.", Default: 0, Type: []string{"integer"}, Format: "int32", @@ -30168,7 +30171,7 @@ func schema_openshift_api_legacyconfig_v1_NodeConfig(ref common.ReferenceCallbac }, "nodeName": { SchemaProps: spec.SchemaProps{ - 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", + 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", Default: "", Type: []string{"string"}, Format: "", @@ -30184,14 +30187,14 @@ func schema_openshift_api_legacyconfig_v1_NodeConfig(ref common.ReferenceCallbac }, "servingInfo": { SchemaProps: spec.SchemaProps{ - Description: "ServingInfo describes how to start serving", + Description: "servingInfo describes how to start serving", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/legacyconfig/v1.ServingInfo"), }, }, "masterKubeConfig": { SchemaProps: spec.SchemaProps{ - Description: "MasterKubeConfig is a filename for the .kubeconfig file that describes how to connect this node to the master", + Description: "masterKubeConfig is a filename for the .kubeconfig file that describes how to connect this node to the master", Default: "", Type: []string{"string"}, Format: "", @@ -30199,13 +30202,13 @@ func schema_openshift_api_legacyconfig_v1_NodeConfig(ref common.ReferenceCallbac }, "masterClientConnectionOverrides": { SchemaProps: spec.SchemaProps{ - Description: "MasterClientConnectionOverrides provides overrides to the client connection used to connect to the master.", + Description: "masterClientConnectionOverrides provides overrides to the client connection used to connect to the master.", Ref: ref("github.com/openshift/api/legacyconfig/v1.ClientConnectionOverrides"), }, }, "dnsDomain": { SchemaProps: spec.SchemaProps{ - Description: "DNSDomain holds the domain suffix that will be used for the DNS search path inside each container. Defaults to 'cluster.local'.", + Description: "dnsDomain holds the domain suffix that will be used for the DNS search path inside each container. Defaults to 'cluster.local'.", Default: "", Type: []string{"string"}, Format: "", @@ -30213,7 +30216,7 @@ func schema_openshift_api_legacyconfig_v1_NodeConfig(ref common.ReferenceCallbac }, "dnsIP": { SchemaProps: spec.SchemaProps{ - 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.", + 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.", Default: "", Type: []string{"string"}, Format: "", @@ -30221,7 +30224,7 @@ func schema_openshift_api_legacyconfig_v1_NodeConfig(ref common.ReferenceCallbac }, "dnsBindAddress": { SchemaProps: spec.SchemaProps{ - 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.", + 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.", Default: "", Type: []string{"string"}, Format: "", @@ -30229,7 +30232,7 @@ func schema_openshift_api_legacyconfig_v1_NodeConfig(ref common.ReferenceCallbac }, "dnsNameservers": { SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -30244,7 +30247,7 @@ func schema_openshift_api_legacyconfig_v1_NodeConfig(ref common.ReferenceCallbac }, "dnsRecursiveResolvConf": { SchemaProps: spec.SchemaProps{ - 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.", + 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.", Default: "", Type: []string{"string"}, Format: "", @@ -30259,14 +30262,14 @@ func schema_openshift_api_legacyconfig_v1_NodeConfig(ref common.ReferenceCallbac }, "networkConfig": { SchemaProps: spec.SchemaProps{ - Description: "NetworkConfig provides network options for the node", + Description: "networkConfig provides network options for the node", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/legacyconfig/v1.NodeNetworkConfig"), }, }, "volumeDirectory": { SchemaProps: spec.SchemaProps{ - Description: "VolumeDirectory is the directory that volumes will be stored under", + Description: "volumeDirectory is the directory that volumes will be stored under", Default: "", Type: []string{"string"}, Format: "", @@ -30274,14 +30277,14 @@ func schema_openshift_api_legacyconfig_v1_NodeConfig(ref common.ReferenceCallbac }, "imageConfig": { SchemaProps: spec.SchemaProps{ - Description: "ImageConfig holds options that describe how to build image names for system components", + Description: "imageConfig holds options that describe how to build image names for system components", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/legacyconfig/v1.ImageConfig"), }, }, "allowDisabledDocker": { SchemaProps: spec.SchemaProps{ - 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.", + 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.", Default: false, Type: []string{"boolean"}, Format: "", @@ -30289,27 +30292,27 @@ func schema_openshift_api_legacyconfig_v1_NodeConfig(ref common.ReferenceCallbac }, "podManifestConfig": { SchemaProps: spec.SchemaProps{ - Description: "PodManifestConfig holds the configuration for enabling the Kubelet to create pods based from a manifest file(s) placed locally on the node", + Description: "podManifestConfig holds the configuration for enabling the Kubelet to create pods based from a manifest file(s) placed locally on the node", Ref: ref("github.com/openshift/api/legacyconfig/v1.PodManifestConfig"), }, }, "authConfig": { SchemaProps: spec.SchemaProps{ - Description: "AuthConfig holds authn/authz configuration options", + Description: "authConfig holds authn/authz configuration options", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/legacyconfig/v1.NodeAuthConfig"), }, }, "dockerConfig": { SchemaProps: spec.SchemaProps{ - Description: "DockerConfig holds Docker related configuration options.", + Description: "dockerConfig holds Docker related configuration options.", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/legacyconfig/v1.DockerConfig"), }, }, "kubeletArguments": { SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"object"}, AdditionalProperties: &spec.SchemaOrBool{ Allows: true, @@ -30332,7 +30335,7 @@ func schema_openshift_api_legacyconfig_v1_NodeConfig(ref common.ReferenceCallbac }, "proxyArguments": { SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"object"}, AdditionalProperties: &spec.SchemaOrBool{ Allows: true, @@ -30355,7 +30358,7 @@ func schema_openshift_api_legacyconfig_v1_NodeConfig(ref common.ReferenceCallbac }, "iptablesSyncPeriod": { SchemaProps: spec.SchemaProps{ - Description: "IPTablesSyncPeriod is how often iptable rules are refreshed", + Description: "iptablesSyncPeriod is how often iptable rules are refreshed", Default: "", Type: []string{"string"}, Format: "", @@ -30363,14 +30366,14 @@ func schema_openshift_api_legacyconfig_v1_NodeConfig(ref common.ReferenceCallbac }, "enableUnidling": { SchemaProps: spec.SchemaProps{ - Description: "EnableUnidling controls whether or not the hybrid unidling proxy will be set up", + Description: "enableUnidling controls whether or not the hybrid unidling proxy will be set up", Type: []string{"boolean"}, Format: "", }, }, "volumeConfig": { SchemaProps: spec.SchemaProps{ - Description: "VolumeConfig contains options for configuring volumes on the node.", + Description: "volumeConfig contains options for configuring volumes on the node.", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/legacyconfig/v1.NodeVolumeConfig"), }, @@ -30393,7 +30396,7 @@ func schema_openshift_api_legacyconfig_v1_NodeNetworkConfig(ref common.Reference Properties: map[string]spec.Schema{ "networkPluginName": { SchemaProps: spec.SchemaProps{ - Description: "NetworkPluginName is a string specifying the networking plugin", + Description: "networkPluginName is a string specifying the networking plugin", Default: "", Type: []string{"string"}, Format: "", @@ -30423,7 +30426,7 @@ func schema_openshift_api_legacyconfig_v1_NodeVolumeConfig(ref common.ReferenceC Properties: map[string]spec.Schema{ "localQuota": { SchemaProps: spec.SchemaProps{ - Description: "LocalQuota contains options for controlling local volume quota on the node.", + Description: "localQuota contains options for controlling local volume quota on the node.", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/legacyconfig/v1.LocalQuota"), }, @@ -30446,14 +30449,14 @@ func schema_openshift_api_legacyconfig_v1_OAuthConfig(ref common.ReferenceCallba Properties: map[string]spec.Schema{ "masterCA": { SchemaProps: spec.SchemaProps{ - Description: "MasterCA is the CA for verifying the TLS connection back to the MasterURL.", + Description: "masterCA is the CA for verifying the TLS connection back to the MasterURL.", Type: []string{"string"}, Format: "", }, }, "masterURL": { SchemaProps: spec.SchemaProps{ - Description: "MasterURL is used for making server-to-server calls to exchange authorization codes for access tokens", + Description: "masterURL is used for making server-to-server calls to exchange authorization codes for access tokens", Default: "", Type: []string{"string"}, Format: "", @@ -30461,7 +30464,7 @@ func schema_openshift_api_legacyconfig_v1_OAuthConfig(ref common.ReferenceCallba }, "masterPublicURL": { SchemaProps: spec.SchemaProps{ - Description: "MasterPublicURL is used for building valid client redirect URLs for internal and external access", + Description: "masterPublicURL is used for building valid client redirect URLs for internal and external access", Default: "", Type: []string{"string"}, Format: "", @@ -30469,7 +30472,7 @@ func schema_openshift_api_legacyconfig_v1_OAuthConfig(ref common.ReferenceCallba }, "assetPublicURL": { SchemaProps: spec.SchemaProps{ - Description: "AssetPublicURL is used for building valid client redirect URLs for external access", + Description: "assetPublicURL is used for building valid client redirect URLs for external access", Default: "", Type: []string{"string"}, Format: "", @@ -30477,7 +30480,7 @@ func schema_openshift_api_legacyconfig_v1_OAuthConfig(ref common.ReferenceCallba }, "alwaysShowProviderSelection": { SchemaProps: spec.SchemaProps{ - Description: "AlwaysShowProviderSelection will force the provider selection page to render even when there is only a single provider.", + Description: "alwaysShowProviderSelection will force the provider selection page to render even when there is only a single provider.", Default: false, Type: []string{"boolean"}, Format: "", @@ -30485,7 +30488,7 @@ func schema_openshift_api_legacyconfig_v1_OAuthConfig(ref common.ReferenceCallba }, "identityProviders": { SchemaProps: spec.SchemaProps{ - Description: "IdentityProviders is an ordered list of ways for a user to identify themselves", + Description: "identityProviders is an ordered list of ways for a user to identify themselves", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -30499,27 +30502,27 @@ func schema_openshift_api_legacyconfig_v1_OAuthConfig(ref common.ReferenceCallba }, "grantConfig": { SchemaProps: spec.SchemaProps{ - Description: "GrantConfig describes how to handle grants", + Description: "grantConfig describes how to handle grants", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/legacyconfig/v1.GrantConfig"), }, }, "sessionConfig": { SchemaProps: spec.SchemaProps{ - Description: "SessionConfig hold information about configuring sessions.", + Description: "sessionConfig hold information about configuring sessions.", Ref: ref("github.com/openshift/api/legacyconfig/v1.SessionConfig"), }, }, "tokenConfig": { SchemaProps: spec.SchemaProps{ - Description: "TokenConfig contains options for authorization and access tokens", + Description: "tokenConfig contains options for authorization and access tokens", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/legacyconfig/v1.TokenConfig"), }, }, "templates": { SchemaProps: spec.SchemaProps{ - Description: "Templates allow you to customize pages like the login page.", + Description: "templates allow you to customize pages like the login page.", Ref: ref("github.com/openshift/api/legacyconfig/v1.OAuthTemplates"), }, }, @@ -30541,7 +30544,7 @@ func schema_openshift_api_legacyconfig_v1_OAuthTemplates(ref common.ReferenceCal Properties: map[string]spec.Schema{ "login": { SchemaProps: spec.SchemaProps{ - 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.", + 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.", Default: "", Type: []string{"string"}, Format: "", @@ -30549,7 +30552,7 @@ func schema_openshift_api_legacyconfig_v1_OAuthTemplates(ref common.ReferenceCal }, "providerSelection": { SchemaProps: spec.SchemaProps{ - 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.", + 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.", Default: "", Type: []string{"string"}, Format: "", @@ -30557,7 +30560,7 @@ func schema_openshift_api_legacyconfig_v1_OAuthTemplates(ref common.ReferenceCal }, "error": { SchemaProps: spec.SchemaProps{ - 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.", + 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.", Default: "", Type: []string{"string"}, Format: "", @@ -30579,7 +30582,7 @@ func schema_openshift_api_legacyconfig_v1_OpenIDClaims(ref common.ReferenceCallb Properties: map[string]spec.Schema{ "id": { SchemaProps: spec.SchemaProps{ - Description: "ID is the list of claims whose values should be used as the user ID. Required. OpenID standard identity claim is \"sub\"", + Description: "id is the list of claims whose values should be used as the user ID. Required. OpenID standard identity claim is \"sub\"", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -30594,7 +30597,7 @@ func schema_openshift_api_legacyconfig_v1_OpenIDClaims(ref common.ReferenceCallb }, "preferredUsername": { SchemaProps: spec.SchemaProps{ - 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", + 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: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -30609,7 +30612,7 @@ func schema_openshift_api_legacyconfig_v1_OpenIDClaims(ref common.ReferenceCallb }, "name": { SchemaProps: spec.SchemaProps{ - 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", + 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: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -30624,7 +30627,7 @@ func schema_openshift_api_legacyconfig_v1_OpenIDClaims(ref common.ReferenceCallb }, "email": { SchemaProps: spec.SchemaProps{ - 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", + 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: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -30667,7 +30670,7 @@ func schema_openshift_api_legacyconfig_v1_OpenIDIdentityProvider(ref common.Refe }, "ca": { SchemaProps: spec.SchemaProps{ - 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", + 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", Default: "", Type: []string{"string"}, Format: "", @@ -30675,7 +30678,7 @@ func schema_openshift_api_legacyconfig_v1_OpenIDIdentityProvider(ref common.Refe }, "clientID": { SchemaProps: spec.SchemaProps{ - Description: "ClientID is the oauth client ID", + Description: "clientID is the oauth client ID", Default: "", Type: []string{"string"}, Format: "", @@ -30683,13 +30686,13 @@ func schema_openshift_api_legacyconfig_v1_OpenIDIdentityProvider(ref common.Refe }, "clientSecret": { SchemaProps: spec.SchemaProps{ - Description: "ClientSecret is the oauth client secret", + Description: "clientSecret is the oauth client secret", Ref: ref("github.com/openshift/api/legacyconfig/v1.StringSource"), }, }, "extraScopes": { SchemaProps: spec.SchemaProps{ - Description: "ExtraScopes are any scopes to request in addition to the standard \"openid\" scope.", + Description: "extraScopes are any scopes to request in addition to the standard \"openid\" scope.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -30704,7 +30707,7 @@ func schema_openshift_api_legacyconfig_v1_OpenIDIdentityProvider(ref common.Refe }, "extraAuthorizeParameters": { SchemaProps: spec.SchemaProps{ - Description: "ExtraAuthorizeParameters are any custom parameters to add to the authorize request.", + Description: "extraAuthorizeParameters are any custom parameters to add to the authorize request.", Type: []string{"object"}, AdditionalProperties: &spec.SchemaOrBool{ Allows: true, @@ -30720,14 +30723,14 @@ func schema_openshift_api_legacyconfig_v1_OpenIDIdentityProvider(ref common.Refe }, "urls": { SchemaProps: spec.SchemaProps{ - Description: "URLs to use to authenticate", + Description: "urls to use to authenticate", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/legacyconfig/v1.OpenIDURLs"), }, }, "claims": { SchemaProps: spec.SchemaProps{ - Description: "Claims mappings", + Description: "claims mappings", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/legacyconfig/v1.OpenIDClaims"), }, @@ -30750,7 +30753,7 @@ func schema_openshift_api_legacyconfig_v1_OpenIDURLs(ref common.ReferenceCallbac Properties: map[string]spec.Schema{ "authorize": { SchemaProps: spec.SchemaProps{ - Description: "Authorize is the oauth authorization URL", + Description: "authorize is the oauth authorization URL", Default: "", Type: []string{"string"}, Format: "", @@ -30758,7 +30761,7 @@ func schema_openshift_api_legacyconfig_v1_OpenIDURLs(ref common.ReferenceCallbac }, "token": { SchemaProps: spec.SchemaProps{ - Description: "Token is the oauth token granting URL", + Description: "token is the oauth token granting URL", Default: "", Type: []string{"string"}, Format: "", @@ -30766,7 +30769,7 @@ func schema_openshift_api_legacyconfig_v1_OpenIDURLs(ref common.ReferenceCallbac }, "userInfo": { SchemaProps: spec.SchemaProps{ - 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", + 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", Default: "", Type: []string{"string"}, Format: "", @@ -30788,7 +30791,7 @@ func schema_openshift_api_legacyconfig_v1_PodManifestConfig(ref common.Reference Properties: map[string]spec.Schema{ "path": { SchemaProps: spec.SchemaProps{ - 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", + 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", Default: "", Type: []string{"string"}, Format: "", @@ -30796,7 +30799,7 @@ func schema_openshift_api_legacyconfig_v1_PodManifestConfig(ref common.Reference }, "fileCheckIntervalSeconds": { SchemaProps: spec.SchemaProps{ - Description: "FileCheckIntervalSeconds is the interval in seconds for checking the manifest file(s) for new data The interval needs to be a positive value", + Description: "fileCheckIntervalSeconds is the interval in seconds for checking the manifest file(s) for new data The interval needs to be a positive value", Default: 0, Type: []string{"integer"}, Format: "int64", @@ -30818,7 +30821,7 @@ func schema_openshift_api_legacyconfig_v1_PolicyConfig(ref common.ReferenceCallb Properties: map[string]spec.Schema{ "userAgentMatchingConfig": { SchemaProps: spec.SchemaProps{ - Description: "UserAgentMatchingConfig controls how API calls from *voluntarily* identifying clients will be handled. THIS DOES NOT DEFEND AGAINST MALICIOUS CLIENTS!", + Description: "userAgentMatchingConfig controls how API calls from *voluntarily* identifying clients will be handled. THIS DOES NOT DEFEND AGAINST MALICIOUS CLIENTS!", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/legacyconfig/v1.UserAgentMatchingConfig"), }, @@ -30841,7 +30844,7 @@ func schema_openshift_api_legacyconfig_v1_ProjectConfig(ref common.ReferenceCall Properties: map[string]spec.Schema{ "defaultNodeSelector": { SchemaProps: spec.SchemaProps{ - Description: "DefaultNodeSelector holds default project node label selector", + Description: "defaultNodeSelector holds default project node label selector", Default: "", Type: []string{"string"}, Format: "", @@ -30849,7 +30852,7 @@ func schema_openshift_api_legacyconfig_v1_ProjectConfig(ref common.ReferenceCall }, "projectRequestMessage": { SchemaProps: spec.SchemaProps{ - Description: "ProjectRequestMessage is the string presented to a user if they are unable to request a project via the projectrequest api endpoint", + Description: "projectRequestMessage is the string presented to a user if they are unable to request a project via the projectrequest api endpoint", Default: "", Type: []string{"string"}, Format: "", @@ -30857,7 +30860,7 @@ func schema_openshift_api_legacyconfig_v1_ProjectConfig(ref common.ReferenceCall }, "projectRequestTemplate": { SchemaProps: spec.SchemaProps{ - 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.", + 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.", Default: "", Type: []string{"string"}, Format: "", @@ -30865,7 +30868,7 @@ func schema_openshift_api_legacyconfig_v1_ProjectConfig(ref common.ReferenceCall }, "securityAllocator": { SchemaProps: spec.SchemaProps{ - Description: "SecurityAllocator controls the automatic allocation of UIDs and MCS labels to a project. If nil, allocation is disabled.", + Description: "securityAllocator controls the automatic allocation of UIDs and MCS labels to a project. If nil, allocation is disabled.", Ref: ref("github.com/openshift/api/legacyconfig/v1.SecurityAllocator"), }, }, @@ -30902,7 +30905,7 @@ func schema_openshift_api_legacyconfig_v1_RFC2307Config(ref common.ReferenceCall }, "groupNameAttributes": { SchemaProps: spec.SchemaProps{ - Description: "GroupNameAttributes defines which attributes on an LDAP group entry will be interpreted as its name to use for an OpenShift group", + Description: "groupNameAttributes defines which attributes on an LDAP group entry will be interpreted as its name to use for an OpenShift group", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -30917,7 +30920,7 @@ func schema_openshift_api_legacyconfig_v1_RFC2307Config(ref common.ReferenceCall }, "groupMembershipAttributes": { SchemaProps: spec.SchemaProps{ - 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", + 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: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -30939,7 +30942,7 @@ func schema_openshift_api_legacyconfig_v1_RFC2307Config(ref common.ReferenceCall }, "userUIDAttribute": { SchemaProps: spec.SchemaProps{ - 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", + 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", Default: "", Type: []string{"string"}, Format: "", @@ -30947,7 +30950,7 @@ func schema_openshift_api_legacyconfig_v1_RFC2307Config(ref common.ReferenceCall }, "userNameAttributes": { SchemaProps: spec.SchemaProps{ - 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", + 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: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -30962,7 +30965,7 @@ func schema_openshift_api_legacyconfig_v1_RFC2307Config(ref common.ReferenceCall }, "tolerateMemberNotFoundErrors": { SchemaProps: spec.SchemaProps{ - 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.", + 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.", Default: false, Type: []string{"boolean"}, Format: "", @@ -30970,7 +30973,7 @@ func schema_openshift_api_legacyconfig_v1_RFC2307Config(ref common.ReferenceCall }, "tolerateMemberOutOfScopeErrors": { SchemaProps: spec.SchemaProps{ - 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.", + 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.", Default: false, Type: []string{"boolean"}, Format: "", @@ -30994,7 +30997,7 @@ func schema_openshift_api_legacyconfig_v1_RegistryLocation(ref common.ReferenceC Properties: map[string]spec.Schema{ "domainName": { SchemaProps: spec.SchemaProps{ - 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.", + 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.", Default: "", Type: []string{"string"}, Format: "", @@ -31002,7 +31005,7 @@ func schema_openshift_api_legacyconfig_v1_RegistryLocation(ref common.ReferenceC }, "insecure": { SchemaProps: spec.SchemaProps{ - Description: "Insecure indicates whether the registry is secure (https) or insecure (http) By default (if not specified) the registry is assumed as secure.", + Description: "insecure indicates whether the registry is secure (https) or insecure (http) By default (if not specified) the registry is assumed as secure.", Type: []string{"boolean"}, Format: "", }, @@ -31023,7 +31026,7 @@ func schema_openshift_api_legacyconfig_v1_RemoteConnectionInfo(ref common.Refere Properties: map[string]spec.Schema{ "url": { SchemaProps: spec.SchemaProps{ - Description: "URL is the remote URL to connect to", + Description: "url is the remote URL to connect to", Default: "", Type: []string{"string"}, Format: "", @@ -31031,7 +31034,7 @@ func schema_openshift_api_legacyconfig_v1_RemoteConnectionInfo(ref common.Refere }, "ca": { SchemaProps: spec.SchemaProps{ - Description: "CA is the CA for verifying TLS connections", + Description: "ca is the CA for verifying TLS connections", Default: "", Type: []string{"string"}, Format: "", @@ -31039,7 +31042,7 @@ func schema_openshift_api_legacyconfig_v1_RemoteConnectionInfo(ref common.Refere }, "certFile": { SchemaProps: spec.SchemaProps{ - Description: "CertFile is a file containing a PEM-encoded certificate", + Description: "certFile is a file containing a PEM-encoded certificate", Default: "", Type: []string{"string"}, Format: "", @@ -31047,7 +31050,7 @@ func schema_openshift_api_legacyconfig_v1_RemoteConnectionInfo(ref common.Refere }, "keyFile": { SchemaProps: spec.SchemaProps{ - Description: "KeyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile", + Description: "keyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile", Default: "", Type: []string{"string"}, Format: "", @@ -31069,7 +31072,7 @@ func schema_openshift_api_legacyconfig_v1_RequestHeaderAuthenticationOptions(ref Properties: map[string]spec.Schema{ "clientCA": { SchemaProps: spec.SchemaProps{ - Description: "ClientCA is a file with the trusted signer certs. It is required.", + Description: "clientCA is a file with the trusted signer certs. It is required.", Default: "", Type: []string{"string"}, Format: "", @@ -31077,7 +31080,7 @@ func schema_openshift_api_legacyconfig_v1_RequestHeaderAuthenticationOptions(ref }, "clientCommonNames": { SchemaProps: spec.SchemaProps{ - Description: "ClientCommonNames is a required list of common names to require a match from.", + Description: "clientCommonNames is a required list of common names to require a match from.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -31092,7 +31095,7 @@ func schema_openshift_api_legacyconfig_v1_RequestHeaderAuthenticationOptions(ref }, "usernameHeaders": { SchemaProps: spec.SchemaProps{ - Description: "UsernameHeaders is the list of headers to check for user information. First hit wins.", + Description: "usernameHeaders is the list of headers to check for user information. First hit wins.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -31122,7 +31125,7 @@ func schema_openshift_api_legacyconfig_v1_RequestHeaderAuthenticationOptions(ref }, "extraHeaderPrefixes": { SchemaProps: spec.SchemaProps{ - Description: "ExtraHeaderPrefixes is the set of request header prefixes to inspect for user extra. X-Remote-Extra- is suggested.", + Description: "extraHeaderPrefixes is the set of request header prefixes to inspect for user extra. X-Remote-Extra- is suggested.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -31165,7 +31168,7 @@ func schema_openshift_api_legacyconfig_v1_RequestHeaderIdentityProvider(ref comm }, "loginURL": { SchemaProps: spec.SchemaProps{ - 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}", + 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}", Default: "", Type: []string{"string"}, Format: "", @@ -31173,7 +31176,7 @@ func schema_openshift_api_legacyconfig_v1_RequestHeaderIdentityProvider(ref comm }, "challengeURL": { SchemaProps: spec.SchemaProps{ - 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}", + 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}", Default: "", Type: []string{"string"}, Format: "", @@ -31181,7 +31184,7 @@ func schema_openshift_api_legacyconfig_v1_RequestHeaderIdentityProvider(ref comm }, "clientCA": { SchemaProps: spec.SchemaProps{ - 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.", + 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.", Default: "", Type: []string{"string"}, Format: "", @@ -31189,7 +31192,7 @@ func schema_openshift_api_legacyconfig_v1_RequestHeaderIdentityProvider(ref comm }, "clientCommonNames": { SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -31204,7 +31207,7 @@ func schema_openshift_api_legacyconfig_v1_RequestHeaderIdentityProvider(ref comm }, "headers": { SchemaProps: spec.SchemaProps{ - Description: "Headers is the set of headers to check for identity information", + Description: "headers is the set of headers to check for identity information", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -31219,7 +31222,7 @@ func schema_openshift_api_legacyconfig_v1_RequestHeaderIdentityProvider(ref comm }, "preferredUsernameHeaders": { SchemaProps: spec.SchemaProps{ - Description: "PreferredUsernameHeaders is the set of headers to check for the preferred username", + Description: "preferredUsernameHeaders is the set of headers to check for the preferred username", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -31234,7 +31237,7 @@ func schema_openshift_api_legacyconfig_v1_RequestHeaderIdentityProvider(ref comm }, "nameHeaders": { SchemaProps: spec.SchemaProps{ - Description: "NameHeaders is the set of headers to check for the display name", + Description: "nameHeaders is the set of headers to check for the display name", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -31249,7 +31252,7 @@ func schema_openshift_api_legacyconfig_v1_RequestHeaderIdentityProvider(ref comm }, "emailHeaders": { SchemaProps: spec.SchemaProps{ - Description: "EmailHeaders is the set of headers to check for the email address", + Description: "emailHeaders is the set of headers to check for the email address", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -31278,7 +31281,7 @@ func schema_openshift_api_legacyconfig_v1_RoutingConfig(ref common.ReferenceCall Properties: map[string]spec.Schema{ "subdomain": { SchemaProps: spec.SchemaProps{ - 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.", + 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.", Default: "", Type: []string{"string"}, Format: "", @@ -31300,7 +31303,7 @@ func schema_openshift_api_legacyconfig_v1_SecurityAllocator(ref common.Reference Properties: map[string]spec.Schema{ "uidAllocatorRange": { SchemaProps: spec.SchemaProps{ - 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).", + 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).", Default: "", Type: []string{"string"}, Format: "", @@ -31308,7 +31311,7 @@ func schema_openshift_api_legacyconfig_v1_SecurityAllocator(ref common.Reference }, "mcsAllocatorRange": { SchemaProps: spec.SchemaProps{ - 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", + 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", Default: "", Type: []string{"string"}, Format: "", @@ -31316,7 +31319,7 @@ func schema_openshift_api_legacyconfig_v1_SecurityAllocator(ref common.Reference }, "mcsLabelsPerProject": { SchemaProps: spec.SchemaProps{ - 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).", + 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).", Default: 0, Type: []string{"integer"}, Format: "int32", @@ -31338,7 +31341,7 @@ func schema_openshift_api_legacyconfig_v1_ServiceAccountConfig(ref common.Refere Properties: map[string]spec.Schema{ "managedNames": { SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -31353,7 +31356,7 @@ func schema_openshift_api_legacyconfig_v1_ServiceAccountConfig(ref common.Refere }, "limitSecretReferences": { SchemaProps: spec.SchemaProps{ - Description: "LimitSecretReferences controls whether or not to allow a service account to reference any secret in a namespace without explicitly referencing them", + Description: "limitSecretReferences controls whether or not to allow a service account to reference any secret in a namespace without explicitly referencing them", Default: false, Type: []string{"boolean"}, Format: "", @@ -31361,7 +31364,7 @@ func schema_openshift_api_legacyconfig_v1_ServiceAccountConfig(ref common.Refere }, "privateKeyFile": { SchemaProps: spec.SchemaProps{ - 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.", + 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.", Default: "", Type: []string{"string"}, Format: "", @@ -31369,7 +31372,7 @@ func schema_openshift_api_legacyconfig_v1_ServiceAccountConfig(ref common.Refere }, "publicKeyFiles": { SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -31384,7 +31387,7 @@ func schema_openshift_api_legacyconfig_v1_ServiceAccountConfig(ref common.Refere }, "masterCA": { SchemaProps: spec.SchemaProps{ - 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.", + 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.", Default: "", Type: []string{"string"}, Format: "", @@ -31406,7 +31409,7 @@ func schema_openshift_api_legacyconfig_v1_ServiceServingCert(ref common.Referenc Properties: map[string]spec.Schema{ "signer": { SchemaProps: spec.SchemaProps{ - Description: "Signer holds the signing information used to automatically sign serving certificates. If this value is nil, then certs are not signed automatically.", + Description: "signer holds the signing information used to automatically sign serving certificates. If this value is nil, then certs are not signed automatically.", Ref: ref("github.com/openshift/api/legacyconfig/v1.CertInfo"), }, }, @@ -31428,7 +31431,7 @@ func schema_openshift_api_legacyconfig_v1_ServingInfo(ref common.ReferenceCallba Properties: map[string]spec.Schema{ "bindAddress": { SchemaProps: spec.SchemaProps{ - Description: "BindAddress is the ip:port to serve on", + Description: "bindAddress is the ip:port to serve on", Default: "", Type: []string{"string"}, Format: "", @@ -31436,7 +31439,7 @@ func schema_openshift_api_legacyconfig_v1_ServingInfo(ref common.ReferenceCallba }, "bindNetwork": { SchemaProps: spec.SchemaProps{ - Description: "BindNetwork is the type of network to bind to - defaults to \"tcp4\", accepts \"tcp\", \"tcp4\", and \"tcp6\"", + Description: "bindNetwork is the type of network to bind to - defaults to \"tcp4\", accepts \"tcp\", \"tcp4\", and \"tcp6\"", Default: "", Type: []string{"string"}, Format: "", @@ -31444,7 +31447,7 @@ func schema_openshift_api_legacyconfig_v1_ServingInfo(ref common.ReferenceCallba }, "certFile": { SchemaProps: spec.SchemaProps{ - Description: "CertFile is a file containing a PEM-encoded certificate", + Description: "certFile is a file containing a PEM-encoded certificate", Default: "", Type: []string{"string"}, Format: "", @@ -31452,7 +31455,7 @@ func schema_openshift_api_legacyconfig_v1_ServingInfo(ref common.ReferenceCallba }, "keyFile": { SchemaProps: spec.SchemaProps{ - Description: "KeyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile", + Description: "keyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile", Default: "", Type: []string{"string"}, Format: "", @@ -31460,7 +31463,7 @@ func schema_openshift_api_legacyconfig_v1_ServingInfo(ref common.ReferenceCallba }, "clientCA": { SchemaProps: spec.SchemaProps{ - Description: "ClientCA is the certificate bundle for all the signers that you'll recognize for incoming client certificates", + Description: "clientCA is the certificate bundle for all the signers that you'll recognize for incoming client certificates", Default: "", Type: []string{"string"}, Format: "", @@ -31468,7 +31471,7 @@ func schema_openshift_api_legacyconfig_v1_ServingInfo(ref common.ReferenceCallba }, "namedCertificates": { SchemaProps: spec.SchemaProps{ - Description: "NamedCertificates is a list of certificates to use to secure requests to specific hostnames", + Description: "namedCertificates is a list of certificates to use to secure requests to specific hostnames", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -31482,14 +31485,14 @@ func schema_openshift_api_legacyconfig_v1_ServingInfo(ref common.ReferenceCallba }, "minTLSVersion": { SchemaProps: spec.SchemaProps{ - Description: "MinTLSVersion is the minimum TLS version supported. Values must match version names from https://golang.org/pkg/crypto/tls/#pkg-constants", + Description: "minTLSVersion is the minimum TLS version supported. Values must match version names from https://golang.org/pkg/crypto/tls/#pkg-constants", Type: []string{"string"}, Format: "", }, }, "cipherSuites": { SchemaProps: spec.SchemaProps{ - 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", + 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: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -31520,7 +31523,7 @@ func schema_openshift_api_legacyconfig_v1_SessionConfig(ref common.ReferenceCall Properties: map[string]spec.Schema{ "sessionSecretsFile": { SchemaProps: spec.SchemaProps{ - 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", + 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", Default: "", Type: []string{"string"}, Format: "", @@ -31528,7 +31531,7 @@ func schema_openshift_api_legacyconfig_v1_SessionConfig(ref common.ReferenceCall }, "sessionMaxAgeSeconds": { SchemaProps: spec.SchemaProps{ - Description: "SessionMaxAgeSeconds specifies how long created sessions last. Used by AuthRequestHandlerSession", + Description: "sessionMaxAgeSeconds specifies how long created sessions last. Used by AuthRequestHandlerSession", Default: 0, Type: []string{"integer"}, Format: "int32", @@ -31536,7 +31539,7 @@ func schema_openshift_api_legacyconfig_v1_SessionConfig(ref common.ReferenceCall }, "sessionName": { SchemaProps: spec.SchemaProps{ - Description: "SessionName is the cookie name used to store the session", + Description: "sessionName is the cookie name used to store the session", Default: "", Type: []string{"string"}, Format: "", @@ -31558,7 +31561,7 @@ func schema_openshift_api_legacyconfig_v1_SessionSecret(ref common.ReferenceCall Properties: map[string]spec.Schema{ "authentication": { SchemaProps: spec.SchemaProps{ - Description: "Authentication is used to authenticate sessions using HMAC. Recommended to use a secret with 32 or 64 bytes.", + Description: "authentication is used to authenticate sessions using HMAC. Recommended to use a secret with 32 or 64 bytes.", Default: "", Type: []string{"string"}, Format: "", @@ -31566,7 +31569,7 @@ func schema_openshift_api_legacyconfig_v1_SessionSecret(ref common.ReferenceCall }, "encryption": { SchemaProps: spec.SchemaProps{ - Description: "Encryption is used to encrypt sessions. Must be 16, 24, or 32 characters long, to select AES-128, AES-", + Description: "encryption is used to encrypt sessions. Must be 16, 24, or 32 characters long, to select AES-128, AES-", Default: "", Type: []string{"string"}, Format: "", @@ -31602,7 +31605,7 @@ func schema_openshift_api_legacyconfig_v1_SessionSecrets(ref common.ReferenceCal }, "secrets": { SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -31652,7 +31655,7 @@ func schema_openshift_api_legacyconfig_v1_StringSource(ref common.ReferenceCallb Properties: map[string]spec.Schema{ "value": { SchemaProps: spec.SchemaProps{ - Description: "Value specifies the cleartext value, or an encrypted value if keyFile is specified.", + Description: "value specifies the cleartext value, or an encrypted value if keyFile is specified.", Default: "", Type: []string{"string"}, Format: "", @@ -31660,7 +31663,7 @@ func schema_openshift_api_legacyconfig_v1_StringSource(ref common.ReferenceCallb }, "env": { SchemaProps: spec.SchemaProps{ - Description: "Env specifies an envvar containing the cleartext value, or an encrypted value if the keyFile is specified.", + Description: "env specifies an envvar containing the cleartext value, or an encrypted value if the keyFile is specified.", Default: "", Type: []string{"string"}, Format: "", @@ -31668,7 +31671,7 @@ func schema_openshift_api_legacyconfig_v1_StringSource(ref common.ReferenceCallb }, "file": { SchemaProps: spec.SchemaProps{ - Description: "File references a file containing the cleartext value, or an encrypted value if a keyFile is specified.", + Description: "file references a file containing the cleartext value, or an encrypted value if a keyFile is specified.", Default: "", Type: []string{"string"}, Format: "", @@ -31676,7 +31679,7 @@ func schema_openshift_api_legacyconfig_v1_StringSource(ref common.ReferenceCallb }, "keyFile": { SchemaProps: spec.SchemaProps{ - Description: "KeyFile references a file containing the key to use to decrypt the value.", + Description: "keyFile references a file containing the key to use to decrypt the value.", Default: "", Type: []string{"string"}, Format: "", @@ -31698,7 +31701,7 @@ func schema_openshift_api_legacyconfig_v1_StringSourceSpec(ref common.ReferenceC Properties: map[string]spec.Schema{ "value": { SchemaProps: spec.SchemaProps{ - Description: "Value specifies the cleartext value, or an encrypted value if keyFile is specified.", + Description: "value specifies the cleartext value, or an encrypted value if keyFile is specified.", Default: "", Type: []string{"string"}, Format: "", @@ -31706,7 +31709,7 @@ func schema_openshift_api_legacyconfig_v1_StringSourceSpec(ref common.ReferenceC }, "env": { SchemaProps: spec.SchemaProps{ - Description: "Env specifies an envvar containing the cleartext value, or an encrypted value if the keyFile is specified.", + Description: "env specifies an envvar containing the cleartext value, or an encrypted value if the keyFile is specified.", Default: "", Type: []string{"string"}, Format: "", @@ -31714,7 +31717,7 @@ func schema_openshift_api_legacyconfig_v1_StringSourceSpec(ref common.ReferenceC }, "file": { SchemaProps: spec.SchemaProps{ - Description: "File references a file containing the cleartext value, or an encrypted value if a keyFile is specified.", + Description: "file references a file containing the cleartext value, or an encrypted value if a keyFile is specified.", Default: "", Type: []string{"string"}, Format: "", @@ -31722,7 +31725,7 @@ func schema_openshift_api_legacyconfig_v1_StringSourceSpec(ref common.ReferenceC }, "keyFile": { SchemaProps: spec.SchemaProps{ - Description: "KeyFile references a file containing the key to use to decrypt the value.", + Description: "keyFile references a file containing the key to use to decrypt the value.", Default: "", Type: []string{"string"}, Format: "", @@ -31744,7 +31747,7 @@ func schema_openshift_api_legacyconfig_v1_TokenConfig(ref common.ReferenceCallba Properties: map[string]spec.Schema{ "authorizeTokenMaxAgeSeconds": { SchemaProps: spec.SchemaProps{ - Description: "AuthorizeTokenMaxAgeSeconds defines the maximum age of authorize tokens", + Description: "authorizeTokenMaxAgeSeconds defines the maximum age of authorize tokens", Default: 0, Type: []string{"integer"}, Format: "int32", @@ -31752,7 +31755,7 @@ func schema_openshift_api_legacyconfig_v1_TokenConfig(ref common.ReferenceCallba }, "accessTokenMaxAgeSeconds": { SchemaProps: spec.SchemaProps{ - Description: "AccessTokenMaxAgeSeconds defines the maximum age of access tokens", + Description: "accessTokenMaxAgeSeconds defines the maximum age of access tokens", Default: 0, Type: []string{"integer"}, Format: "int32", @@ -31760,7 +31763,7 @@ func schema_openshift_api_legacyconfig_v1_TokenConfig(ref common.ReferenceCallba }, "accessTokenInactivityTimeoutSeconds": { SchemaProps: spec.SchemaProps{ - 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 overriden 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)", + 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 overriden 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: []string{"integer"}, Format: "int32", }, @@ -31789,7 +31792,7 @@ func schema_openshift_api_legacyconfig_v1_UserAgentDenyRule(ref common.Reference }, "httpVerbs": { SchemaProps: spec.SchemaProps{ - Description: "HTTPVerbs specifies which HTTP verbs should be matched. An empty list means \"match all verbs\".", + Description: "httpVerbs specifies which HTTP verbs should be matched. An empty list means \"match all verbs\".", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -31804,7 +31807,7 @@ func schema_openshift_api_legacyconfig_v1_UserAgentDenyRule(ref common.Reference }, "rejectionMessage": { SchemaProps: spec.SchemaProps{ - Description: "RejectionMessage is the message shown when rejecting a client. If it is not a set, the default message is used.", + Description: "rejectionMessage is the message shown when rejecting a client. If it is not a set, the default message is used.", Default: "", Type: []string{"string"}, Format: "", @@ -31834,7 +31837,7 @@ func schema_openshift_api_legacyconfig_v1_UserAgentMatchRule(ref common.Referenc }, "httpVerbs": { SchemaProps: spec.SchemaProps{ - Description: "HTTPVerbs specifies which HTTP verbs should be matched. An empty list means \"match all verbs\".", + Description: "httpVerbs specifies which HTTP verbs should be matched. An empty list means \"match all verbs\".", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -31891,7 +31894,7 @@ func schema_openshift_api_legacyconfig_v1_UserAgentMatchingConfig(ref common.Ref }, "defaultRejectionMessage": { SchemaProps: spec.SchemaProps{ - Description: "DefaultRejectionMessage is the message shown when rejecting a client. If it is not a set, a generic message is given.", + Description: "defaultRejectionMessage is the message shown when rejecting a client. If it is not a set, a generic message is given.", Default: "", Type: []string{"string"}, Format: "", @@ -31915,7 +31918,7 @@ func schema_openshift_api_legacyconfig_v1_WebhookTokenAuthenticator(ref common.R Properties: map[string]spec.Schema{ "configFile": { SchemaProps: spec.SchemaProps{ - Description: "ConfigFile is a path to a Kubeconfig file with the webhook configuration", + Description: "configFile is a path to a Kubeconfig file with the webhook configuration", Default: "", Type: []string{"string"}, Format: "", @@ -31923,7 +31926,7 @@ func schema_openshift_api_legacyconfig_v1_WebhookTokenAuthenticator(ref common.R }, "cacheTTL": { SchemaProps: spec.SchemaProps{ - 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", + 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", Default: "", Type: []string{"string"}, Format: "", @@ -31945,13 +31948,13 @@ func schema_openshift_api_machine_v1_AWSFailureDomain(ref common.ReferenceCallba Properties: map[string]spec.Schema{ "subnet": { SchemaProps: spec.SchemaProps{ - Description: "Subnet is a reference to the subnet to use for this instance.", + Description: "subnet is a reference to the subnet to use for this instance.", Ref: ref("github.com/openshift/api/machine/v1.AWSResourceReference"), }, }, "placement": { SchemaProps: spec.SchemaProps{ - Description: "Placement configures the placement information for this instance.", + Description: "placement configures the placement information for this instance.", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/machine/v1.AWSFailureDomainPlacement"), }, @@ -31973,7 +31976,7 @@ func schema_openshift_api_machine_v1_AWSFailureDomainPlacement(ref common.Refere Properties: map[string]spec.Schema{ "availabilityZone": { SchemaProps: spec.SchemaProps{ - Description: "AvailabilityZone is the availability zone of the instance.", + Description: "availabilityZone is the availability zone of the instance.", Default: "", Type: []string{"string"}, Format: "", @@ -31995,7 +31998,7 @@ func schema_openshift_api_machine_v1_AWSResourceFilter(ref common.ReferenceCallb Properties: map[string]spec.Schema{ "name": { SchemaProps: spec.SchemaProps{ - Description: "Name of the filter. Filter names are case-sensitive.", + Description: "name of the filter. Filter names are case-sensitive.", Default: "", Type: []string{"string"}, Format: "", @@ -32037,7 +32040,7 @@ func schema_openshift_api_machine_v1_AWSResourceReference(ref common.ReferenceCa Properties: map[string]spec.Schema{ "type": { SchemaProps: spec.SchemaProps{ - Description: "Type determines how the reference will fetch the AWS resource.", + Description: "type determines how the reference will fetch the AWS resource.", Default: "", Type: []string{"string"}, Format: "", @@ -32045,14 +32048,14 @@ func schema_openshift_api_machine_v1_AWSResourceReference(ref common.ReferenceCa }, "id": { SchemaProps: spec.SchemaProps{ - Description: "ID of resource.", + Description: "id of resource.", Type: []string{"string"}, Format: "", }, }, "arn": { SchemaProps: spec.SchemaProps{ - Description: "ARN of resource.", + Description: "arn of resource.", Type: []string{"string"}, Format: "", }, @@ -32064,7 +32067,7 @@ func schema_openshift_api_machine_v1_AWSResourceReference(ref common.ReferenceCa }, }, SchemaProps: spec.SchemaProps{ - Description: "Filters is a set of filters used to identify a resource.", + Description: "filters is a set of filters used to identify a resource.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -32183,7 +32186,7 @@ func schema_openshift_api_machine_v1_AlibabaCloudMachineProviderConfig(ref commo }, "securityGroups": { SchemaProps: spec.SchemaProps{ - 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", + 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: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -32197,55 +32200,55 @@ func schema_openshift_api_machine_v1_AlibabaCloudMachineProviderConfig(ref commo }, "bandwidth": { SchemaProps: spec.SchemaProps{ - Description: "Bandwidth describes the internet bandwidth strategy for the instance", + Description: "bandwidth describes the internet bandwidth strategy for the instance", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/machine/v1.BandwidthProperties"), }, }, "systemDisk": { SchemaProps: spec.SchemaProps{ - Description: "SystemDisk holds the properties regarding the system disk for the instance", + Description: "systemDisk holds the properties regarding the system disk for the instance", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/machine/v1.SystemDiskProperties"), }, }, "vSwitch": { SchemaProps: spec.SchemaProps{ - 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.", + 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: map[string]interface{}{}, Ref: ref("github.com/openshift/api/machine/v1.AlibabaResourceReference"), }, }, "ramRoleName": { SchemaProps: spec.SchemaProps{ - 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.", + 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{"string"}, Format: "", }, }, "resourceGroup": { SchemaProps: spec.SchemaProps{ - 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.", + 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: map[string]interface{}{}, Ref: ref("github.com/openshift/api/machine/v1.AlibabaResourceReference"), }, }, "tenancy": { SchemaProps: spec.SchemaProps{ - 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`.", + 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{"string"}, Format: "", }, }, "userDataSecret": { SchemaProps: spec.SchemaProps{ - Description: "UserDataSecret contains a local reference to a secret that contains the UserData to apply to the instance", + Description: "userDataSecret contains a local reference to a secret that contains the UserData to apply to the instance", Ref: ref("k8s.io/api/core/v1.LocalObjectReference"), }, }, "credentialsSecret": { SchemaProps: spec.SchemaProps{ - 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.", + 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: ref("k8s.io/api/core/v1.LocalObjectReference"), }, }, @@ -32352,21 +32355,21 @@ func schema_openshift_api_machine_v1_AlibabaCloudMachineProviderStatus(ref commo }, "instanceId": { SchemaProps: spec.SchemaProps{ - Description: "InstanceID is the instance ID of the machine created in alibabacloud", + Description: "instanceId is the instance ID of the machine created in alibabacloud", Type: []string{"string"}, Format: "", }, }, "instanceState": { SchemaProps: spec.SchemaProps{ - Description: "InstanceState is the state of the alibabacloud instance for this machine", + Description: "instanceState is the state of the alibabacloud instance for this machine", Type: []string{"string"}, Format: "", }, }, "conditions": { SchemaProps: spec.SchemaProps{ - Description: "Conditions is a set of conditions associated with the Machine to indicate errors or other status", + Description: "conditions is a set of conditions associated with the Machine to indicate errors or other status", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -32403,21 +32406,21 @@ func schema_openshift_api_machine_v1_AlibabaResourceReference(ref common.Referen }, "id": { SchemaProps: spec.SchemaProps{ - Description: "ID of resource", + Description: "id of resource", Type: []string{"string"}, Format: "", }, }, "name": { SchemaProps: spec.SchemaProps{ - Description: "Name of the resource", + Description: "name of the resource", Type: []string{"string"}, Format: "", }, }, "tags": { SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -32476,14 +32479,14 @@ func schema_openshift_api_machine_v1_BandwidthProperties(ref common.ReferenceCal Properties: map[string]spec.Schema{ "internetMaxBandwidthIn": { SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"integer"}, Format: "int64", }, }, "internetMaxBandwidthOut": { SchemaProps: spec.SchemaProps{ - 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`", + 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: []string{"integer"}, Format: "int64", }, @@ -32608,7 +32611,7 @@ func schema_openshift_api_machine_v1_ControlPlaneMachineSetSpec(ref common.Refer }, "state": { SchemaProps: spec.SchemaProps{ - 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.", + 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.", Default: "Inactive", Type: []string{"string"}, Format: "", @@ -32616,14 +32619,14 @@ func schema_openshift_api_machine_v1_ControlPlaneMachineSetSpec(ref common.Refer }, "replicas": { SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"integer"}, Format: "int32", }, }, "strategy": { SchemaProps: spec.SchemaProps{ - Description: "Strategy defines how the ControlPlaneMachineSet will update Machines when it detects a change to the ProviderSpec.", + Description: "strategy defines how the ControlPlaneMachineSet will update Machines when it detects a change to the ProviderSpec.", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/machine/v1.ControlPlaneMachineSetStrategy"), }, @@ -32637,7 +32640,7 @@ func schema_openshift_api_machine_v1_ControlPlaneMachineSetSpec(ref common.Refer }, "template": { SchemaProps: spec.SchemaProps{ - Description: "Template describes the Control Plane Machines that will be created by this ControlPlaneMachineSet.", + Description: "template describes the Control Plane Machines that will be created by this ControlPlaneMachineSet.", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/machine/v1.ControlPlaneMachineSetTemplate"), }, @@ -32670,7 +32673,7 @@ func schema_openshift_api_machine_v1_ControlPlaneMachineSetStatus(ref common.Ref }, }, SchemaProps: spec.SchemaProps{ - Description: "Conditions represents the observations of the ControlPlaneMachineSet's current state. Known .status.conditions.type are: Available, Degraded and Progressing.", + Description: "conditions represents the observations of the ControlPlaneMachineSet's current state. Known .status.conditions.type are: Available, Degraded and Progressing.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -32684,35 +32687,35 @@ func schema_openshift_api_machine_v1_ControlPlaneMachineSetStatus(ref common.Ref }, "observedGeneration": { SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"integer"}, Format: "int64", }, }, "replicas": { SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"integer"}, Format: "int32", }, }, "readyReplicas": { SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"integer"}, Format: "int32", }, }, "updatedReplicas": { SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"integer"}, Format: "int32", }, }, "unavailableReplicas": { SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"integer"}, Format: "int32", }, @@ -32734,7 +32737,7 @@ func schema_openshift_api_machine_v1_ControlPlaneMachineSetStrategy(ref common.R Properties: map[string]spec.Schema{ "type": { SchemaProps: spec.SchemaProps{ - 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\".", + 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\".", Default: "RollingUpdate", Type: []string{"string"}, Format: "", @@ -32755,7 +32758,7 @@ func schema_openshift_api_machine_v1_ControlPlaneMachineSetTemplate(ref common.R Properties: map[string]spec.Schema{ "machineType": { SchemaProps: spec.SchemaProps{ - 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.", + 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{"string"}, Format: "", }, @@ -32767,6 +32770,7 @@ func schema_openshift_api_machine_v1_ControlPlaneMachineSetTemplate(ref common.R }, }, }, + Required: []string{"machineType"}, }, VendorExtensible: spec.VendorExtensible{ Extensions: spec.Extensions{ @@ -32811,7 +32815,7 @@ func schema_openshift_api_machine_v1_ControlPlaneMachineSetTemplateObjectMeta(re }, "annotations": { SchemaProps: spec.SchemaProps{ - 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", + 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: []string{"object"}, AdditionalProperties: &spec.SchemaOrBool{ Allows: true, @@ -32918,7 +32922,7 @@ func schema_openshift_api_machine_v1_FailureDomains(ref common.ReferenceCallback Properties: map[string]spec.Schema{ "platform": { SchemaProps: spec.SchemaProps{ - Description: "Platform identifies the platform for which the FailureDomain represents. Currently supported values are AWS, Azure, GCP, OpenStack, VSphere and Nutanix.", + Description: "platform identifies the platform for which the FailureDomain represents. Currently supported values are AWS, Azure, GCP, OpenStack, VSphere and Nutanix.", Default: "", Type: []string{"string"}, Format: "", @@ -32931,7 +32935,7 @@ func schema_openshift_api_machine_v1_FailureDomains(ref common.ReferenceCallback }, }, SchemaProps: spec.SchemaProps{ - Description: "AWS configures failure domain information for the AWS platform.", + Description: "aws configures failure domain information for the AWS platform.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -32950,7 +32954,7 @@ func schema_openshift_api_machine_v1_FailureDomains(ref common.ReferenceCallback }, }, SchemaProps: spec.SchemaProps{ - Description: "Azure configures failure domain information for the Azure platform.", + Description: "azure configures failure domain information for the Azure platform.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -32969,7 +32973,7 @@ func schema_openshift_api_machine_v1_FailureDomains(ref common.ReferenceCallback }, }, SchemaProps: spec.SchemaProps{ - Description: "GCP configures failure domain information for the GCP platform.", + Description: "gcp configures failure domain information for the GCP platform.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -33010,7 +33014,7 @@ func schema_openshift_api_machine_v1_FailureDomains(ref common.ReferenceCallback }, }, SchemaProps: spec.SchemaProps{ - Description: "OpenStack configures failure domain information for the OpenStack platform.", + Description: "openstack configures failure domain information for the OpenStack platform.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -33079,7 +33083,7 @@ func schema_openshift_api_machine_v1_GCPFailureDomain(ref common.ReferenceCallba Properties: map[string]spec.Schema{ "zone": { SchemaProps: spec.SchemaProps{ - Description: "Zone is the zone in which the GCP machine provider will create the VM.", + Description: "zone is the zone in which the GCP machine provider will create the VM.", Default: "", Type: []string{"string"}, Format: "", @@ -33468,7 +33472,7 @@ func schema_openshift_api_machine_v1_NutanixResourceIdentifier(ref common.Refere Properties: map[string]spec.Schema{ "type": { SchemaProps: spec.SchemaProps{ - Description: "Type is the identifier type to use for this resource.", + Description: "type is the identifier type to use for this resource.", Default: "", Type: []string{"string"}, Format: "", @@ -33619,7 +33623,7 @@ func schema_openshift_api_machine_v1_NutanixVMDiskDeviceProperties(ref common.Re }, }, }, - Required: []string{"deviceType"}, + Required: []string{"deviceType", "adapterType", "deviceIndex"}, }, }, } @@ -33664,7 +33668,7 @@ func schema_openshift_api_machine_v1_OpenShiftMachineV1Beta1MachineTemplate(ref Properties: map[string]spec.Schema{ "failureDomains": { SchemaProps: spec.SchemaProps{ - 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.", + 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: ref("github.com/openshift/api/machine/v1.FailureDomains"), }, }, @@ -33677,7 +33681,7 @@ func schema_openshift_api_machine_v1_OpenShiftMachineV1Beta1MachineTemplate(ref }, "spec": { SchemaProps: spec.SchemaProps{ - 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 overriden when the Machines are created based on the FailureDomains field.", + 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 overriden when the Machines are created based on the FailureDomains field.", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/machine/v1beta1.MachineSpec"), }, @@ -33920,28 +33924,28 @@ func schema_openshift_api_machine_v1_PowerVSResource(ref common.ReferenceCallbac Properties: map[string]spec.Schema{ "type": { SchemaProps: spec.SchemaProps{ - Description: "Type identifies the resource type for this entry. Valid values are ID, Name and RegEx", + Description: "type identifies the resource type for this entry. Valid values are ID, Name and RegEx", Type: []string{"string"}, Format: "", }, }, "id": { SchemaProps: spec.SchemaProps{ - Description: "ID of resource", + Description: "id of resource", Type: []string{"string"}, Format: "", }, }, "name": { SchemaProps: spec.SchemaProps{ - Description: "Name of resource", + Description: "name of resource", Type: []string{"string"}, Format: "", }, }, "regex": { SchemaProps: spec.SchemaProps{ - Description: "Regex to find resource Regex contains the pattern to match to find a resource", + Description: "regex to find resource Regex contains the pattern to match to find a resource", Type: []string{"string"}, Format: "", }, @@ -33975,7 +33979,7 @@ func schema_openshift_api_machine_v1_PowerVSSecretReference(ref common.Reference Properties: map[string]spec.Schema{ "name": { SchemaProps: spec.SchemaProps{ - Description: "Name of the secret.", + Description: "name of the secret.", Type: []string{"string"}, Format: "", }, @@ -34029,28 +34033,28 @@ func schema_openshift_api_machine_v1_SystemDiskProperties(ref common.ReferenceCa Properties: map[string]spec.Schema{ "category": { SchemaProps: spec.SchemaProps{ - 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`.", + 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{"string"}, Format: "", }, }, "performanceLevel": { SchemaProps: spec.SchemaProps{ - 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.", + 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{"string"}, Format: "", }, }, "name": { SchemaProps: spec.SchemaProps{ - 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 `\"\"`.", + 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{"string"}, Format: "", }, }, "size": { SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"integer"}, Format: "int64", }, @@ -34440,14 +34444,14 @@ func schema_openshift_api_machine_v1alpha1_NetworkParam(ref common.ReferenceCall }, "noAllowedAddressPairs": { SchemaProps: spec.SchemaProps{ - Description: "NoAllowedAddressPairs disables creation of allowed address pairs for the network ports", + Description: "noAllowedAddressPairs disables creation of allowed address pairs for the network ports", Type: []string{"boolean"}, Format: "", }, }, "portTags": { SchemaProps: spec.SchemaProps{ - Description: "PortTags allows users to specify a list of tags to add to ports created in a given network", + Description: "portTags allows users to specify a list of tags to add to ports created in a given network", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -34485,7 +34489,7 @@ func schema_openshift_api_machine_v1alpha1_NetworkParam(ref common.ReferenceCall }, "portSecurity": { SchemaProps: spec.SchemaProps{ - Description: "PortSecurity optionally enables or disables security on ports managed by OpenStack", + Description: "portSecurity optionally enables or disables security on ports managed by OpenStack", Type: []string{"boolean"}, Format: "", }, @@ -35275,7 +35279,7 @@ func schema_openshift_api_machine_v1alpha1_SubnetParam(ref common.ReferenceCallb }, "portTags": { SchemaProps: spec.SchemaProps{ - Description: "PortTags are tags that are added to ports created on this subnet", + Description: "portTags are tags that are added to ports created on this subnet", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -35290,7 +35294,7 @@ func schema_openshift_api_machine_v1alpha1_SubnetParam(ref common.ReferenceCallb }, "portSecurity": { SchemaProps: spec.SchemaProps{ - Description: "PortSecurity optionally enables or disables security on ports managed by OpenStack", + Description: "portSecurity optionally enables or disables security on ports managed by OpenStack", Type: []string{"boolean"}, Format: "", }, @@ -35332,14 +35336,14 @@ func schema_openshift_api_machine_v1beta1_AWSMachineProviderConfig(ref common.Re }, "ami": { SchemaProps: spec.SchemaProps{ - Description: "AMI is the reference to the AMI from which to create the machine instance.", + Description: "ami is the reference to the AMI from which to create the machine instance.", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/machine/v1beta1.AWSResourceReference"), }, }, "instanceType": { SchemaProps: spec.SchemaProps{ - Description: "InstanceType is the type of instance to create. Example: m4.xlarge", + Description: "instanceType is the type of instance to create. Example: m4.xlarge", Default: "", Type: []string{"string"}, Format: "", @@ -35347,7 +35351,7 @@ func schema_openshift_api_machine_v1beta1_AWSMachineProviderConfig(ref common.Re }, "tags": { SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -35361,32 +35365,32 @@ func schema_openshift_api_machine_v1beta1_AWSMachineProviderConfig(ref common.Re }, "iamInstanceProfile": { SchemaProps: spec.SchemaProps{ - Description: "IAMInstanceProfile is a reference to an IAM role to assign to the instance", + Description: "iamInstanceProfile is a reference to an IAM role to assign to the instance", Ref: ref("github.com/openshift/api/machine/v1beta1.AWSResourceReference"), }, }, "userDataSecret": { SchemaProps: spec.SchemaProps{ - Description: "UserDataSecret contains a local reference to a secret that contains the UserData to apply to the instance", + Description: "userDataSecret contains a local reference to a secret that contains the UserData to apply to the instance", Ref: ref("k8s.io/api/core/v1.LocalObjectReference"), }, }, "credentialsSecret": { SchemaProps: spec.SchemaProps{ - 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.", + 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: ref("k8s.io/api/core/v1.LocalObjectReference"), }, }, "keyName": { SchemaProps: spec.SchemaProps{ - Description: "KeyName is the name of the KeyPair to use for SSH", + Description: "keyName is the name of the KeyPair to use for SSH", Type: []string{"string"}, Format: "", }, }, "deviceIndex": { SchemaProps: spec.SchemaProps{ - Description: "DeviceIndex is the index of the device on the instance for the network interface attachment. Defaults to 0.", + Description: "deviceIndex is the index of the device on the instance for the network interface attachment. Defaults to 0.", Default: 0, Type: []string{"integer"}, Format: "int64", @@ -35394,21 +35398,21 @@ func schema_openshift_api_machine_v1beta1_AWSMachineProviderConfig(ref common.Re }, "publicIp": { SchemaProps: spec.SchemaProps{ - Description: "PublicIP specifies whether the instance should get a public IP. If not present, it should use the default of its subnet.", + Description: "publicIp specifies whether the instance should get a public IP. If not present, it should use the default of its subnet.", Type: []string{"boolean"}, Format: "", }, }, "networkInterfaceType": { SchemaProps: spec.SchemaProps{ - 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.", + 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{"string"}, Format: "", }, }, "securityGroups": { SchemaProps: spec.SchemaProps{ - Description: "SecurityGroups is an array of references to security groups that should be applied to the instance.", + Description: "securityGroups is an array of references to security groups that should be applied to the instance.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -35422,21 +35426,21 @@ func schema_openshift_api_machine_v1beta1_AWSMachineProviderConfig(ref common.Re }, "subnet": { SchemaProps: spec.SchemaProps{ - Description: "Subnet is a reference to the subnet to use for this instance", + Description: "subnet is a reference to the subnet to use for this instance", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/machine/v1beta1.AWSResourceReference"), }, }, "placement": { SchemaProps: spec.SchemaProps{ - Description: "Placement specifies where to create the instance in AWS", + Description: "placement specifies where to create the instance in AWS", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/machine/v1beta1.Placement"), }, }, "loadBalancers": { SchemaProps: spec.SchemaProps{ - Description: "LoadBalancers is the set of load balancers to which the new instance should be added once it is created.", + Description: "loadBalancers is the set of load balancers to which the new instance should be added once it is created.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -35450,7 +35454,7 @@ func schema_openshift_api_machine_v1beta1_AWSMachineProviderConfig(ref common.Re }, "blockDevices": { SchemaProps: spec.SchemaProps{ - 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", + 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: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -35464,20 +35468,20 @@ func schema_openshift_api_machine_v1beta1_AWSMachineProviderConfig(ref common.Re }, "spotMarketOptions": { SchemaProps: spec.SchemaProps{ - Description: "SpotMarketOptions allows users to configure instances to be run using AWS Spot instances.", + Description: "spotMarketOptions allows users to configure instances to be run using AWS Spot instances.", Ref: ref("github.com/openshift/api/machine/v1beta1.SpotMarketOptions"), }, }, "metadataServiceOptions": { SchemaProps: spec.SchemaProps{ - 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", + 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: map[string]interface{}{}, Ref: ref("github.com/openshift/api/machine/v1beta1.MetadataServiceOptions"), }, }, "placementGroupName": { SchemaProps: spec.SchemaProps{ - 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.", + 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{"string"}, Format: "", }, @@ -35578,21 +35582,21 @@ func schema_openshift_api_machine_v1beta1_AWSMachineProviderStatus(ref common.Re }, "instanceId": { SchemaProps: spec.SchemaProps{ - Description: "InstanceID is the instance ID of the machine created in AWS", + Description: "instanceId is the instance ID of the machine created in AWS", Type: []string{"string"}, Format: "", }, }, "instanceState": { SchemaProps: spec.SchemaProps{ - Description: "InstanceState is the state of the AWS instance for this machine", + Description: "instanceState is the state of the AWS instance for this machine", Type: []string{"string"}, Format: "", }, }, "conditions": { SchemaProps: spec.SchemaProps{ - Description: "Conditions is a set of conditions associated with the Machine to indicate errors or other status", + Description: "conditions is a set of conditions associated with the Machine to indicate errors or other status", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -35621,21 +35625,21 @@ func schema_openshift_api_machine_v1beta1_AWSResourceReference(ref common.Refere Properties: map[string]spec.Schema{ "id": { SchemaProps: spec.SchemaProps{ - Description: "ID of resource", + Description: "id of resource", Type: []string{"string"}, Format: "", }, }, "arn": { SchemaProps: spec.SchemaProps{ - Description: "ARN of resource", + Description: "arn of resource", Type: []string{"string"}, Format: "", }, }, "filters": { SchemaProps: spec.SchemaProps{ - Description: "Filters is a set of filters used to identify a resource", + Description: "filters is a set of filters used to identify a resource", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -35702,7 +35706,7 @@ func schema_openshift_api_machine_v1beta1_AzureBootDiagnostics(ref common.Refere Properties: map[string]spec.Schema{ "storageAccountType": { SchemaProps: spec.SchemaProps{ - Description: "StorageAccountType determines if the storage account for storing the diagnostics data should be provisioned by Azure (AzureManaged) or by the customer (CustomerManaged).", + Description: "storageAccountType determines if the storage account for storing the diagnostics data should be provisioned by Azure (AzureManaged) or by the customer (CustomerManaged).", Default: "", Type: []string{"string"}, Format: "", @@ -35710,7 +35714,7 @@ func schema_openshift_api_machine_v1beta1_AzureBootDiagnostics(ref common.Refere }, "customerManaged": { SchemaProps: spec.SchemaProps{ - Description: "CustomerManaged provides reference to the customer manager storage account.", + Description: "customerManaged provides reference to the customer manager storage account.", Ref: ref("github.com/openshift/api/machine/v1beta1.AzureCustomerManagedBootDiagnostics"), }, }, @@ -35744,7 +35748,7 @@ func schema_openshift_api_machine_v1beta1_AzureCustomerManagedBootDiagnostics(re Properties: map[string]spec.Schema{ "storageAccountURI": { SchemaProps: spec.SchemaProps{ - 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.", + 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.", Default: "", Type: []string{"string"}, Format: "", @@ -35807,40 +35811,40 @@ func schema_openshift_api_machine_v1beta1_AzureMachineProviderSpec(ref common.Re }, "userDataSecret": { SchemaProps: spec.SchemaProps{ - Description: "UserDataSecret contains a local reference to a secret that contains the UserData to apply to the instance", + Description: "userDataSecret contains a local reference to a secret that contains the UserData to apply to the instance", Ref: ref("k8s.io/api/core/v1.SecretReference"), }, }, "credentialsSecret": { SchemaProps: spec.SchemaProps{ - Description: "CredentialsSecret is a reference to the secret with Azure credentials.", + Description: "credentialsSecret is a reference to the secret with Azure credentials.", Ref: ref("k8s.io/api/core/v1.SecretReference"), }, }, "location": { SchemaProps: spec.SchemaProps{ - Description: "Location is the region to use to create the instance", + Description: "location is the region to use to create the instance", Type: []string{"string"}, Format: "", }, }, "vmSize": { SchemaProps: spec.SchemaProps{ - Description: "VMSize is the size of the VM to create.", + Description: "vmSize is the size of the VM to create.", Type: []string{"string"}, Format: "", }, }, "image": { SchemaProps: spec.SchemaProps{ - Description: "Image is the OS image to use to create the instance.", + Description: "image is the OS image to use to create the instance.", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/machine/v1beta1.Image"), }, }, "osDisk": { SchemaProps: spec.SchemaProps{ - Description: "OSDisk represents the parameters for creating the OS disk.", + Description: "osDisk represents the parameters for creating the OS disk.", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/machine/v1beta1.OSDisk"), }, @@ -35861,14 +35865,14 @@ func schema_openshift_api_machine_v1beta1_AzureMachineProviderSpec(ref common.Re }, "sshPublicKey": { SchemaProps: spec.SchemaProps{ - Description: "SSHPublicKey is the public key to use to SSH to the virtual machine.", + Description: "sshPublicKey is the public key to use to SSH to the virtual machine.", Type: []string{"string"}, Format: "", }, }, "publicIP": { SchemaProps: spec.SchemaProps{ - Description: "PublicIP if true a public IP will be used", + Description: "publicIP if true a public IP will be used", Default: false, Type: []string{"boolean"}, Format: "", @@ -35876,7 +35880,7 @@ func schema_openshift_api_machine_v1beta1_AzureMachineProviderSpec(ref common.Re }, "tags": { SchemaProps: spec.SchemaProps{ - Description: "Tags is a list of tags to apply to the machine.", + Description: "tags is a list of tags to apply to the machine.", Type: []string{"object"}, AdditionalProperties: &spec.SchemaOrBool{ Allows: true, @@ -35914,7 +35918,7 @@ func schema_openshift_api_machine_v1beta1_AzureMachineProviderSpec(ref common.Re }, "subnet": { SchemaProps: spec.SchemaProps{ - Description: "Subnet to use for this instance", + Description: "subnet to use for this instance", Default: "", Type: []string{"string"}, Format: "", @@ -35922,7 +35926,7 @@ func schema_openshift_api_machine_v1beta1_AzureMachineProviderSpec(ref common.Re }, "publicLoadBalancer": { SchemaProps: spec.SchemaProps{ - Description: "PublicLoadBalancer to use for this instance", + Description: "publicLoadBalancer to use for this instance", Type: []string{"string"}, Format: "", }, @@ -35936,21 +35940,21 @@ func schema_openshift_api_machine_v1beta1_AzureMachineProviderSpec(ref common.Re }, "natRule": { SchemaProps: spec.SchemaProps{ - Description: "NatRule to set inbound NAT rule of the load balancer", + Description: "natRule to set inbound NAT rule of the load balancer", Type: []string{"integer"}, Format: "int64", }, }, "managedIdentity": { SchemaProps: spec.SchemaProps{ - Description: "ManagedIdentity to set managed identity name", + Description: "managedIdentity to set managed identity name", Type: []string{"string"}, Format: "", }, }, "vnet": { SchemaProps: spec.SchemaProps{ - Description: "Vnet to set virtual network name", + Description: "vnet to set virtual network name", Type: []string{"string"}, Format: "", }, @@ -35964,54 +35968,54 @@ func schema_openshift_api_machine_v1beta1_AzureMachineProviderSpec(ref common.Re }, "networkResourceGroup": { SchemaProps: spec.SchemaProps{ - Description: "NetworkResourceGroup is the resource group for the virtual machine's network", + Description: "networkResourceGroup is the resource group for the virtual machine's network", Type: []string{"string"}, Format: "", }, }, "resourceGroup": { SchemaProps: spec.SchemaProps{ - Description: "ResourceGroup is the resource group for the virtual machine", + Description: "resourceGroup is the resource group for the virtual machine", Type: []string{"string"}, Format: "", }, }, "spotVMOptions": { SchemaProps: spec.SchemaProps{ - Description: "SpotVMOptions allows the ability to specify the Machine should use a Spot VM", + Description: "spotVMOptions allows the ability to specify the Machine should use a Spot VM", Ref: ref("github.com/openshift/api/machine/v1beta1.SpotVMOptions"), }, }, "securityProfile": { SchemaProps: spec.SchemaProps{ - Description: "SecurityProfile specifies the Security profile settings for a virtual machine.", + Description: "securityProfile specifies the Security profile settings for a virtual machine.", Ref: ref("github.com/openshift/api/machine/v1beta1.SecurityProfile"), }, }, "ultraSSDCapability": { SchemaProps: spec.SchemaProps{ - 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.", + 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{"string"}, Format: "", }, }, "acceleratedNetworking": { SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"boolean"}, Format: "", }, }, "availabilitySet": { SchemaProps: spec.SchemaProps{ - Description: "AvailabilitySet specifies the availability set to use for this instance. Availability set should be precreated, before using this field.", + Description: "availabilitySet specifies the availability set to use for this instance. Availability set should be precreated, before using this field.", Type: []string{"string"}, Format: "", }, }, "diagnostics": { SchemaProps: spec.SchemaProps{ - 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.", + 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: map[string]interface{}{}, Ref: ref("github.com/openshift/api/machine/v1beta1.AzureDiagnostics"), }, @@ -36061,21 +36065,21 @@ func schema_openshift_api_machine_v1beta1_AzureMachineProviderStatus(ref common. }, "vmId": { SchemaProps: spec.SchemaProps{ - Description: "VMID is the ID of the virtual machine created in Azure.", + Description: "vmId is the ID of the virtual machine created in Azure.", Type: []string{"string"}, Format: "", }, }, "vmState": { SchemaProps: spec.SchemaProps{ - Description: "VMState is the provisioning state of the Azure virtual machine.", + Description: "vmState is the provisioning state of the Azure virtual machine.", Type: []string{"string"}, Format: "", }, }, "conditions": { SchemaProps: spec.SchemaProps{ - Description: "Conditions is a set of conditions associated with the Machine to indicate errors or other status.", + Description: "conditions is a set of conditions associated with the Machine to indicate errors or other status.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -36146,7 +36150,7 @@ func schema_openshift_api_machine_v1beta1_Condition(ref common.ReferenceCallback Properties: map[string]spec.Schema{ "type": { SchemaProps: spec.SchemaProps{ - 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.", + 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.", Default: "", Type: []string{"string"}, Format: "", @@ -36154,7 +36158,7 @@ func schema_openshift_api_machine_v1beta1_Condition(ref common.ReferenceCallback }, "status": { SchemaProps: spec.SchemaProps{ - Description: "Status of the condition, one of True, False, Unknown.", + Description: "status of the condition, one of True, False, Unknown.", Default: "", Type: []string{"string"}, Format: "", @@ -36162,7 +36166,7 @@ func schema_openshift_api_machine_v1beta1_Condition(ref common.ReferenceCallback }, "severity": { SchemaProps: spec.SchemaProps{ - 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.", + 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{"string"}, Format: "", }, @@ -36211,6 +36215,7 @@ func schema_openshift_api_machine_v1beta1_ConfidentialVM(ref common.ReferenceCal }, }, }, + Required: []string{"uefiSettings"}, }, }, Dependencies: []string{ @@ -36227,7 +36232,7 @@ func schema_openshift_api_machine_v1beta1_DataDisk(ref common.ReferenceCallback) Properties: map[string]spec.Schema{ "nameSuffix": { SchemaProps: spec.SchemaProps{ - 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.", + 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.", Default: "", Type: []string{"string"}, Format: "", @@ -36235,7 +36240,7 @@ func schema_openshift_api_machine_v1beta1_DataDisk(ref common.ReferenceCallback) }, "diskSizeGB": { SchemaProps: spec.SchemaProps{ - Description: "DiskSizeGB is the size in GB to assign to the data disk.", + Description: "diskSizeGB is the size in GB to assign to the data disk.", Default: 0, Type: []string{"integer"}, Format: "int32", @@ -36243,35 +36248,35 @@ func schema_openshift_api_machine_v1beta1_DataDisk(ref common.ReferenceCallback) }, "managedDisk": { SchemaProps: spec.SchemaProps{ - 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\".", + 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: map[string]interface{}{}, Ref: ref("github.com/openshift/api/machine/v1beta1.DataDiskManagedDiskParameters"), }, }, "lun": { SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"integer"}, Format: "int32", }, }, "cachingType": { SchemaProps: spec.SchemaProps{ - 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.", + 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{"string"}, Format: "", }, }, "deletionPolicy": { SchemaProps: spec.SchemaProps{ - 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.", + 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.", Default: "", Type: []string{"string"}, Format: "", }, }, }, - Required: []string{"nameSuffix", "diskSizeGB", "deletionPolicy"}, + Required: []string{"nameSuffix", "diskSizeGB", "lun", "deletionPolicy"}, }, }, Dependencies: []string{ @@ -36415,7 +36420,7 @@ func schema_openshift_api_machine_v1beta1_Filter(ref common.ReferenceCallback) c Properties: map[string]spec.Schema{ "name": { SchemaProps: spec.SchemaProps{ - Description: "Name of the filter. Filter names are case-sensitive.", + Description: "name of the filter. Filter names are case-sensitive.", Default: "", Type: []string{"string"}, Format: "", @@ -36423,7 +36428,7 @@ func schema_openshift_api_machine_v1beta1_Filter(ref common.ReferenceCallback) c }, "values": { SchemaProps: spec.SchemaProps{ - Description: "Values includes one or more filter values. Filter values are case-sensitive.", + Description: "values includes one or more filter values. Filter values are case-sensitive.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -36452,7 +36457,7 @@ func schema_openshift_api_machine_v1beta1_GCPDisk(ref common.ReferenceCallback) Properties: map[string]spec.Schema{ "autoDelete": { SchemaProps: spec.SchemaProps{ - Description: "AutoDelete indicates if the disk will be auto-deleted when the instance is deleted (default false).", + Description: "autoDelete indicates if the disk will be auto-deleted when the instance is deleted (default false).", Default: false, Type: []string{"boolean"}, Format: "", @@ -36460,7 +36465,7 @@ func schema_openshift_api_machine_v1beta1_GCPDisk(ref common.ReferenceCallback) }, "boot": { SchemaProps: spec.SchemaProps{ - Description: "Boot indicates if this is a boot disk (default false).", + Description: "boot indicates if this is a boot disk (default false).", Default: false, Type: []string{"boolean"}, Format: "", @@ -36468,7 +36473,7 @@ func schema_openshift_api_machine_v1beta1_GCPDisk(ref common.ReferenceCallback) }, "sizeGb": { SchemaProps: spec.SchemaProps{ - Description: "SizeGB is the size of the disk (in GB).", + Description: "sizeGb is the size of the disk (in GB).", Default: 0, Type: []string{"integer"}, Format: "int64", @@ -36476,7 +36481,7 @@ func schema_openshift_api_machine_v1beta1_GCPDisk(ref common.ReferenceCallback) }, "type": { SchemaProps: spec.SchemaProps{ - Description: "Type is the type of the disk (eg: pd-standard).", + Description: "type is the type of the disk (eg: pd-standard).", Default: "", Type: []string{"string"}, Format: "", @@ -36484,7 +36489,7 @@ func schema_openshift_api_machine_v1beta1_GCPDisk(ref common.ReferenceCallback) }, "image": { SchemaProps: spec.SchemaProps{ - Description: "Image is the source image to create this disk.", + Description: "image is the source image to create this disk.", Default: "", Type: []string{"string"}, Format: "", @@ -36492,7 +36497,7 @@ func schema_openshift_api_machine_v1beta1_GCPDisk(ref common.ReferenceCallback) }, "labels": { SchemaProps: spec.SchemaProps{ - Description: "Labels list of labels to apply to the disk.", + Description: "labels list of labels to apply to the disk.", Type: []string{"object"}, AdditionalProperties: &spec.SchemaOrBool{ Allows: true, @@ -36508,7 +36513,7 @@ func schema_openshift_api_machine_v1beta1_GCPDisk(ref common.ReferenceCallback) }, "encryptionKey": { SchemaProps: spec.SchemaProps{ - Description: "EncryptionKey is the customer-supplied encryption key of the disk.", + Description: "encryptionKey is the customer-supplied encryption key of the disk.", Ref: ref("github.com/openshift/api/machine/v1beta1.GCPEncryptionKeyReference"), }, }, @@ -36536,7 +36541,7 @@ func schema_openshift_api_machine_v1beta1_GCPEncryptionKeyReference(ref common.R }, "kmsKeyServiceAccount": { SchemaProps: spec.SchemaProps{ - 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.", + 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{"string"}, Format: "", }, @@ -36558,7 +36563,7 @@ func schema_openshift_api_machine_v1beta1_GCPGPUConfig(ref common.ReferenceCallb Properties: map[string]spec.Schema{ "count": { SchemaProps: spec.SchemaProps{ - Description: "Count is the number of GPUs to be attached to an instance.", + Description: "count is the number of GPUs to be attached to an instance.", Default: 0, Type: []string{"integer"}, Format: "int32", @@ -36566,7 +36571,7 @@ func schema_openshift_api_machine_v1beta1_GCPGPUConfig(ref common.ReferenceCallb }, "type": { SchemaProps: spec.SchemaProps{ - 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", + 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", Default: "", Type: []string{"string"}, Format: "", @@ -36588,7 +36593,7 @@ func schema_openshift_api_machine_v1beta1_GCPKMSKeyReference(ref common.Referenc Properties: map[string]spec.Schema{ "name": { SchemaProps: spec.SchemaProps{ - Description: "Name is the name of the customer managed encryption key to be used for the disk encryption.", + Description: "name is the name of the customer managed encryption key to be used for the disk encryption.", Default: "", Type: []string{"string"}, Format: "", @@ -36596,7 +36601,7 @@ func schema_openshift_api_machine_v1beta1_GCPKMSKeyReference(ref common.Referenc }, "keyRing": { SchemaProps: spec.SchemaProps{ - Description: "KeyRing is the name of the KMS Key Ring which the KMS Key belongs to.", + Description: "keyRing is the name of the KMS Key Ring which the KMS Key belongs to.", Default: "", Type: []string{"string"}, Format: "", @@ -36604,14 +36609,14 @@ func schema_openshift_api_machine_v1beta1_GCPKMSKeyReference(ref common.Referenc }, "projectID": { SchemaProps: spec.SchemaProps{ - Description: "ProjectID is the ID of the Project in which the KMS Key Ring exists. Defaults to the VM ProjectID if not set.", + 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{"string"}, Format: "", }, }, "location": { SchemaProps: spec.SchemaProps{ - Description: "Location is the GCP location in which the Key Ring exists.", + Description: "location is the GCP location in which the Key Ring exists.", Default: "", Type: []string{"string"}, Format: "", @@ -36654,19 +36659,19 @@ func schema_openshift_api_machine_v1beta1_GCPMachineProviderSpec(ref common.Refe }, "userDataSecret": { SchemaProps: spec.SchemaProps{ - Description: "UserDataSecret contains a local reference to a secret that contains the UserData to apply to the instance", + Description: "userDataSecret contains a local reference to a secret that contains the UserData to apply to the instance", Ref: ref("k8s.io/api/core/v1.LocalObjectReference"), }, }, "credentialsSecret": { SchemaProps: spec.SchemaProps{ - Description: "CredentialsSecret is a reference to the secret with GCP credentials.", + Description: "credentialsSecret is a reference to the secret with GCP credentials.", Ref: ref("k8s.io/api/core/v1.LocalObjectReference"), }, }, "canIPForward": { SchemaProps: spec.SchemaProps{ - 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.", + 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.", Default: false, Type: []string{"boolean"}, Format: "", @@ -36674,7 +36679,7 @@ func schema_openshift_api_machine_v1beta1_GCPMachineProviderSpec(ref common.Refe }, "deletionProtection": { SchemaProps: spec.SchemaProps{ - Description: "DeletionProtection whether the resource should be protected against deletion.", + Description: "deletionProtection whether the resource should be protected against deletion.", Default: false, Type: []string{"boolean"}, Format: "", @@ -36682,7 +36687,7 @@ func schema_openshift_api_machine_v1beta1_GCPMachineProviderSpec(ref common.Refe }, "disks": { SchemaProps: spec.SchemaProps{ - Description: "Disks is a list of disks to be attached to the VM.", + Description: "disks is a list of disks to be attached to the VM.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -36695,7 +36700,7 @@ func schema_openshift_api_machine_v1beta1_GCPMachineProviderSpec(ref common.Refe }, "labels": { SchemaProps: spec.SchemaProps{ - Description: "Labels list of labels to apply to the VM.", + Description: "labels list of labels to apply to the VM.", Type: []string{"object"}, AdditionalProperties: &spec.SchemaOrBool{ Allows: true, @@ -36724,7 +36729,7 @@ func schema_openshift_api_machine_v1beta1_GCPMachineProviderSpec(ref common.Refe }, "networkInterfaces": { SchemaProps: spec.SchemaProps{ - Description: "NetworkInterfaces is a list of network interfaces to be attached to the VM.", + Description: "networkInterfaces is a list of network interfaces to be attached to the VM.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -36737,7 +36742,7 @@ func schema_openshift_api_machine_v1beta1_GCPMachineProviderSpec(ref common.Refe }, "serviceAccounts": { SchemaProps: spec.SchemaProps{ - Description: "ServiceAccounts is a list of GCP service accounts to be used by the VM.", + Description: "serviceAccounts is a list of GCP service accounts to be used by the VM.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -36751,7 +36756,7 @@ func schema_openshift_api_machine_v1beta1_GCPMachineProviderSpec(ref common.Refe }, "tags": { SchemaProps: spec.SchemaProps{ - Description: "Tags list of network tags to apply to the VM.", + Description: "tags list of network tags to apply to the VM.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -36766,7 +36771,7 @@ func schema_openshift_api_machine_v1beta1_GCPMachineProviderSpec(ref common.Refe }, "targetPools": { SchemaProps: spec.SchemaProps{ - 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", + 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: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -36781,7 +36786,7 @@ func schema_openshift_api_machine_v1beta1_GCPMachineProviderSpec(ref common.Refe }, "machineType": { SchemaProps: spec.SchemaProps{ - Description: "MachineType is the machine type to use for the VM.", + Description: "machineType is the machine type to use for the VM.", Default: "", Type: []string{"string"}, Format: "", @@ -36789,7 +36794,7 @@ func schema_openshift_api_machine_v1beta1_GCPMachineProviderSpec(ref common.Refe }, "region": { SchemaProps: spec.SchemaProps{ - Description: "Region is the region in which the GCP machine provider will create the VM.", + Description: "region is the region in which the GCP machine provider will create the VM.", Default: "", Type: []string{"string"}, Format: "", @@ -36797,7 +36802,7 @@ func schema_openshift_api_machine_v1beta1_GCPMachineProviderSpec(ref common.Refe }, "zone": { SchemaProps: spec.SchemaProps{ - Description: "Zone is the zone in which the GCP machine provider will create the VM.", + Description: "zone is the zone in which the GCP machine provider will create the VM.", Default: "", Type: []string{"string"}, Format: "", @@ -36805,14 +36810,14 @@ func schema_openshift_api_machine_v1beta1_GCPMachineProviderSpec(ref common.Refe }, "projectID": { SchemaProps: spec.SchemaProps{ - Description: "ProjectID is the project in which the GCP machine provider will create the VM.", + Description: "projectID is the project in which the GCP machine provider will create the VM.", Type: []string{"string"}, Format: "", }, }, "gpus": { SchemaProps: spec.SchemaProps{ - Description: "GPUs is a list of GPUs to be attached to the VM.", + Description: "gpus is a list of GPUs to be attached to the VM.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -36826,28 +36831,28 @@ func schema_openshift_api_machine_v1beta1_GCPMachineProviderSpec(ref common.Refe }, "preemptible": { SchemaProps: spec.SchemaProps{ - Description: "Preemptible indicates if created instance is preemptible.", + Description: "preemptible indicates if created instance is preemptible.", Type: []string{"boolean"}, Format: "", }, }, "onHostMaintenance": { SchemaProps: spec.SchemaProps{ - 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\".", + 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{"string"}, Format: "", }, }, "restartPolicy": { SchemaProps: spec.SchemaProps{ - 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", + 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{"string"}, Format: "", }, }, "shieldedInstanceConfig": { SchemaProps: spec.SchemaProps{ - Description: "ShieldedInstanceConfig is the Shielded VM configuration for the VM", + Description: "shieldedInstanceConfig is the Shielded VM configuration for the VM", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/machine/v1beta1.GCPShieldedInstanceConfig"), }, @@ -36919,21 +36924,21 @@ func schema_openshift_api_machine_v1beta1_GCPMachineProviderStatus(ref common.Re }, "instanceId": { SchemaProps: spec.SchemaProps{ - Description: "InstanceID is the ID of the instance in GCP", + Description: "instanceId is the ID of the instance in GCP", Type: []string{"string"}, Format: "", }, }, "instanceState": { SchemaProps: spec.SchemaProps{ - Description: "InstanceState is the provisioning state of the GCP Instance.", + Description: "instanceState is the provisioning state of the GCP Instance.", Type: []string{"string"}, Format: "", }, }, "conditions": { SchemaProps: spec.SchemaProps{ - Description: "Conditions is a set of conditions associated with the Machine to indicate errors or other status", + Description: "conditions is a set of conditions associated with the Machine to indicate errors or other status", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -36962,7 +36967,7 @@ func schema_openshift_api_machine_v1beta1_GCPMetadata(ref common.ReferenceCallba Properties: map[string]spec.Schema{ "key": { SchemaProps: spec.SchemaProps{ - Description: "Key is the metadata key.", + Description: "key is the metadata key.", Default: "", Type: []string{"string"}, Format: "", @@ -36970,7 +36975,7 @@ func schema_openshift_api_machine_v1beta1_GCPMetadata(ref common.ReferenceCallba }, "value": { SchemaProps: spec.SchemaProps{ - Description: "Value is the metadata value.", + Description: "value is the metadata value.", Type: []string{"string"}, Format: "", }, @@ -36991,28 +36996,28 @@ func schema_openshift_api_machine_v1beta1_GCPNetworkInterface(ref common.Referen Properties: map[string]spec.Schema{ "publicIP": { SchemaProps: spec.SchemaProps{ - Description: "PublicIP indicates if true a public IP will be used", + Description: "publicIP indicates if true a public IP will be used", Type: []string{"boolean"}, Format: "", }, }, "network": { SchemaProps: spec.SchemaProps{ - Description: "Network is the network name.", + Description: "network is the network name.", Type: []string{"string"}, Format: "", }, }, "projectID": { SchemaProps: spec.SchemaProps{ - Description: "ProjectID is the project in which the GCP machine provider will create the VM.", + Description: "projectID is the project in which the GCP machine provider will create the VM.", Type: []string{"string"}, Format: "", }, }, "subnetwork": { SchemaProps: spec.SchemaProps{ - Description: "Subnetwork is the subnetwork name.", + Description: "subnetwork is the subnetwork name.", Type: []string{"string"}, Format: "", }, @@ -37032,7 +37037,7 @@ func schema_openshift_api_machine_v1beta1_GCPServiceAccount(ref common.Reference Properties: map[string]spec.Schema{ "email": { SchemaProps: spec.SchemaProps{ - Description: "Email is the service account email.", + Description: "email is the service account email.", Default: "", Type: []string{"string"}, Format: "", @@ -37040,7 +37045,7 @@ func schema_openshift_api_machine_v1beta1_GCPServiceAccount(ref common.Reference }, "scopes": { SchemaProps: spec.SchemaProps{ - Description: "Scopes list of scopes to be assigned to the service account.", + Description: "scopes list of scopes to be assigned to the service account.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -37103,7 +37108,7 @@ func schema_openshift_api_machine_v1beta1_Image(ref common.ReferenceCallback) co Properties: map[string]spec.Schema{ "publisher": { SchemaProps: spec.SchemaProps{ - Description: "Publisher is the name of the organization that created the image", + Description: "publisher is the name of the organization that created the image", Default: "", Type: []string{"string"}, Format: "", @@ -37111,7 +37116,7 @@ func schema_openshift_api_machine_v1beta1_Image(ref common.ReferenceCallback) co }, "offer": { SchemaProps: spec.SchemaProps{ - Description: "Offer specifies the name of a group of related images created by the publisher. For example, UbuntuServer, WindowsServer", + Description: "offer specifies the name of a group of related images created by the publisher. For example, UbuntuServer, WindowsServer", Default: "", Type: []string{"string"}, Format: "", @@ -37119,7 +37124,7 @@ func schema_openshift_api_machine_v1beta1_Image(ref common.ReferenceCallback) co }, "sku": { SchemaProps: spec.SchemaProps{ - Description: "SKU specifies an instance of an offer, such as a major release of a distribution. For example, 18.04-LTS, 2019-Datacenter", + Description: "sku specifies an instance of an offer, such as a major release of a distribution. For example, 18.04-LTS, 2019-Datacenter", Default: "", Type: []string{"string"}, Format: "", @@ -37127,7 +37132,7 @@ func schema_openshift_api_machine_v1beta1_Image(ref common.ReferenceCallback) co }, "version": { SchemaProps: spec.SchemaProps{ - 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.", + 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.", Default: "", Type: []string{"string"}, Format: "", @@ -37135,7 +37140,7 @@ func schema_openshift_api_machine_v1beta1_Image(ref common.ReferenceCallback) co }, "resourceID": { SchemaProps: spec.SchemaProps{ - Description: "ResourceID specifies an image to use by ID", + Description: "resourceID specifies an image to use by ID", Default: "", Type: []string{"string"}, Format: "", @@ -37143,7 +37148,7 @@ func schema_openshift_api_machine_v1beta1_Image(ref common.ReferenceCallback) co }, "type": { SchemaProps: spec.SchemaProps{ - 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", + 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{"string"}, Format: "", }, @@ -37164,14 +37169,14 @@ func schema_openshift_api_machine_v1beta1_LastOperation(ref common.ReferenceCall Properties: map[string]spec.Schema{ "description": { SchemaProps: spec.SchemaProps{ - Description: "Description is the human-readable description of the last operation.", + Description: "description is the human-readable description of the last operation.", Type: []string{"string"}, Format: "", }, }, "lastUpdated": { SchemaProps: spec.SchemaProps{ - Description: "LastUpdated is the timestamp at which LastOperation API was last-updated.", + Description: "lastUpdated is the timestamp at which LastOperation API was last-updated.", Ref: ref("k8s.io/apimachinery/pkg/apis/meta/v1.Time"), }, }, @@ -37206,7 +37211,7 @@ func schema_openshift_api_machine_v1beta1_LifecycleHook(ref common.ReferenceCall Properties: map[string]spec.Schema{ "name": { SchemaProps: spec.SchemaProps{ - 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.", + 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.", Default: "", Type: []string{"string"}, Format: "", @@ -37214,7 +37219,7 @@ func schema_openshift_api_machine_v1beta1_LifecycleHook(ref common.ReferenceCall }, "owner": { SchemaProps: spec.SchemaProps{ - 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.", + 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.", Default: "", Type: []string{"string"}, Format: "", @@ -37244,7 +37249,7 @@ func schema_openshift_api_machine_v1beta1_LifecycleHooks(ref common.ReferenceCal }, }, SchemaProps: spec.SchemaProps{ - Description: "PreDrain hooks prevent the machine from being drained. This also blocks further lifecycle events, such as termination.", + Description: "preDrain hooks prevent the machine from being drained. This also blocks further lifecycle events, such as termination.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -37266,7 +37271,7 @@ func schema_openshift_api_machine_v1beta1_LifecycleHooks(ref common.ReferenceCal }, }, SchemaProps: spec.SchemaProps{ - Description: "PreTerminate hooks prevent the machine from being terminated. PreTerminate hooks be actioned after the Machine has been drained.", + Description: "preTerminate hooks prevent the machine from being terminated. PreTerminate hooks be actioned after the Machine has been drained.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -37478,7 +37483,7 @@ func schema_openshift_api_machine_v1beta1_MachineHealthCheckSpec(ref common.Refe }, "unhealthyConditions": { SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -37504,7 +37509,7 @@ func schema_openshift_api_machine_v1beta1_MachineHealthCheckSpec(ref common.Refe }, "remediationTemplate": { SchemaProps: spec.SchemaProps{ - 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.", + 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: ref("k8s.io/api/core/v1.ObjectReference"), }, }, @@ -37540,7 +37545,7 @@ func schema_openshift_api_machine_v1beta1_MachineHealthCheckStatus(ref common.Re }, "remediationsAllowed": { SchemaProps: spec.SchemaProps{ - Description: "RemediationsAllowed is the number of further remediations allowed by this machine health check before maxUnhealthy short circuiting will be applied", + Description: "remediationsAllowed is the number of further remediations allowed by this machine health check before maxUnhealthy short circuiting will be applied", Default: 0, Type: []string{"integer"}, Format: "int32", @@ -37556,7 +37561,7 @@ func schema_openshift_api_machine_v1beta1_MachineHealthCheckStatus(ref common.Re }, }, SchemaProps: spec.SchemaProps{ - Description: "Conditions defines the current state of the MachineHealthCheck", + Description: "conditions defines the current state of the MachineHealthCheck", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -37734,35 +37739,35 @@ func schema_openshift_api_machine_v1beta1_MachineSetSpec(ref common.ReferenceCal Properties: map[string]spec.Schema{ "replicas": { SchemaProps: spec.SchemaProps{ - Description: "Replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1.", + Description: "replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1.", Type: []string{"integer"}, Format: "int32", }, }, "minReadySeconds": { SchemaProps: spec.SchemaProps{ - 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)", + 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: []string{"integer"}, Format: "int32", }, }, "deletePolicy": { SchemaProps: spec.SchemaProps{ - Description: "DeletePolicy defines the policy used to identify nodes to delete when downscaling. Defaults to \"Random\". Valid values are \"Random, \"Newest\", \"Oldest\"", + Description: "deletePolicy defines the policy used to identify nodes to delete when downscaling. Defaults to \"Random\". Valid values are \"Random, \"Newest\", \"Oldest\"", Type: []string{"string"}, Format: "", }, }, "selector": { SchemaProps: spec.SchemaProps{ - 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", + 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: map[string]interface{}{}, Ref: ref("k8s.io/apimachinery/pkg/apis/meta/v1.LabelSelector"), }, }, "template": { SchemaProps: spec.SchemaProps{ - Description: "Template is the object that describes the machine that will be created if insufficient replicas are detected.", + Description: "template is the object that describes the machine that will be created if insufficient replicas are detected.", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/machine/v1beta1.MachineTemplateSpec"), }, @@ -37793,7 +37798,7 @@ func schema_openshift_api_machine_v1beta1_MachineSetStatus(ref common.ReferenceC Properties: map[string]spec.Schema{ "replicas": { SchemaProps: spec.SchemaProps{ - Description: "Replicas is the most recently observed number of replicas.", + Description: "replicas is the most recently observed number of replicas.", Default: 0, Type: []string{"integer"}, Format: "int32", @@ -37822,7 +37827,7 @@ func schema_openshift_api_machine_v1beta1_MachineSetStatus(ref common.ReferenceC }, "observedGeneration": { SchemaProps: spec.SchemaProps{ - Description: "ObservedGeneration reflects the generation of the most recently observed MachineSet.", + Description: "observedGeneration reflects the generation of the most recently observed MachineSet.", Type: []string{"integer"}, Format: "int64", }, @@ -37850,7 +37855,7 @@ func schema_openshift_api_machine_v1beta1_MachineSetStatus(ref common.ReferenceC }, }, SchemaProps: spec.SchemaProps{ - Description: "Conditions defines the current state of the MachineSet", + Description: "conditions defines the current state of the MachineSet", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -37901,7 +37906,7 @@ func schema_openshift_api_machine_v1beta1_MachineSpec(ref common.ReferenceCallba }, "lifecycleHooks": { SchemaProps: spec.SchemaProps{ - Description: "LifecycleHooks allow users to pause operations on the machine at certain predefined points within the machine lifecycle.", + Description: "lifecycleHooks allow users to pause operations on the machine at certain predefined points within the machine lifecycle.", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/machine/v1beta1.LifecycleHooks"), }, @@ -37927,14 +37932,14 @@ func schema_openshift_api_machine_v1beta1_MachineSpec(ref common.ReferenceCallba }, "providerSpec": { SchemaProps: spec.SchemaProps{ - Description: "ProviderSpec details Provider-specific configuration to use during node creation.", + Description: "providerSpec details Provider-specific configuration to use during node creation.", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/machine/v1beta1.ProviderSpec"), }, }, "providerID": { SchemaProps: spec.SchemaProps{ - 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.", + 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{"string"}, Format: "", }, @@ -37964,33 +37969,33 @@ func schema_openshift_api_machine_v1beta1_MachineStatus(ref common.ReferenceCall Properties: map[string]spec.Schema{ "nodeRef": { SchemaProps: spec.SchemaProps{ - Description: "NodeRef will point to the corresponding Node if it exists.", + Description: "nodeRef will point to the corresponding Node if it exists.", Ref: ref("k8s.io/api/core/v1.ObjectReference"), }, }, "lastUpdated": { SchemaProps: spec.SchemaProps{ - Description: "LastUpdated identifies when this status was last observed.", + Description: "lastUpdated identifies when this status was last observed.", Ref: ref("k8s.io/apimachinery/pkg/apis/meta/v1.Time"), }, }, "errorReason": { SchemaProps: spec.SchemaProps{ - 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.", + 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{"string"}, Format: "", }, }, "errorMessage": { SchemaProps: spec.SchemaProps{ - 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.", + 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{"string"}, Format: "", }, }, "providerStatus": { SchemaProps: spec.SchemaProps{ - 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.", + 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: ref("k8s.io/apimachinery/pkg/runtime.RawExtension"), }, }, @@ -38001,7 +38006,7 @@ func schema_openshift_api_machine_v1beta1_MachineStatus(ref common.ReferenceCall }, }, SchemaProps: spec.SchemaProps{ - Description: "Addresses is a list of addresses assigned to the machine. Queried from cloud provider, if available.", + Description: "addresses is a list of addresses assigned to the machine. Queried from cloud provider, if available.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -38015,13 +38020,13 @@ func schema_openshift_api_machine_v1beta1_MachineStatus(ref common.ReferenceCall }, "lastOperation": { SchemaProps: spec.SchemaProps{ - 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.", + 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: ref("github.com/openshift/api/machine/v1beta1.LastOperation"), }, }, "phase": { SchemaProps: spec.SchemaProps{ - Description: "Phase represents the current phase of machine actuation. One of: Failed, Provisioning, Provisioned, Running, Deleting", + Description: "phase represents the current phase of machine actuation. One of: Failed, Provisioning, Provisioned, Running, Deleting", Type: []string{"string"}, Format: "", }, @@ -38036,7 +38041,7 @@ func schema_openshift_api_machine_v1beta1_MachineStatus(ref common.ReferenceCall }, }, SchemaProps: spec.SchemaProps{ - Description: "Conditions defines the current state of the Machine", + Description: "conditions defines the current state of the Machine", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -38108,7 +38113,7 @@ func schema_openshift_api_machine_v1beta1_MetadataServiceOptions(ref common.Refe Properties: map[string]spec.Schema{ "authentication": { SchemaProps: spec.SchemaProps{ - 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", + 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{"string"}, Format: "", }, @@ -38201,7 +38206,7 @@ func schema_openshift_api_machine_v1beta1_NetworkSpec(ref common.ReferenceCallba Properties: map[string]spec.Schema{ "devices": { SchemaProps: spec.SchemaProps{ - Description: "Devices defines the virtual machine's network interfaces.", + Description: "devices defines the virtual machine's network interfaces.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -38230,7 +38235,7 @@ func schema_openshift_api_machine_v1beta1_OSDisk(ref common.ReferenceCallback) c Properties: map[string]spec.Schema{ "osType": { SchemaProps: spec.SchemaProps{ - Description: "OSType is the operating system type of the OS disk. Possible values include \"Linux\" and \"Windows\".", + Description: "osType is the operating system type of the OS disk. Possible values include \"Linux\" and \"Windows\".", Default: "", Type: []string{"string"}, Format: "", @@ -38238,14 +38243,14 @@ func schema_openshift_api_machine_v1beta1_OSDisk(ref common.ReferenceCallback) c }, "managedDisk": { SchemaProps: spec.SchemaProps{ - Description: "ManagedDisk specifies the Managed Disk parameters for the OS disk.", + Description: "managedDisk specifies the Managed Disk parameters for the OS disk.", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/machine/v1beta1.OSDiskManagedDiskParameters"), }, }, "diskSizeGB": { SchemaProps: spec.SchemaProps{ - Description: "DiskSizeGB is the size in GB to assign to the data disk.", + Description: "diskSizeGB is the size in GB to assign to the data disk.", Default: 0, Type: []string{"integer"}, Format: "int32", @@ -38253,14 +38258,14 @@ func schema_openshift_api_machine_v1beta1_OSDisk(ref common.ReferenceCallback) c }, "diskSettings": { SchemaProps: spec.SchemaProps{ - Description: "DiskSettings describe ephemeral disk settings for the os disk.", + Description: "diskSettings describe ephemeral disk settings for the os disk.", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/machine/v1beta1.DiskSettings"), }, }, "cachingType": { SchemaProps: spec.SchemaProps{ - 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`.", + 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{"string"}, Format: "", }, @@ -38320,21 +38325,21 @@ func schema_openshift_api_machine_v1beta1_ObjectMeta(ref common.ReferenceCallbac Properties: map[string]spec.Schema{ "name": { SchemaProps: spec.SchemaProps{ - 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", + 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{"string"}, Format: "", }, }, "generateName": { SchemaProps: spec.SchemaProps{ - 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", + 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{"string"}, Format: "", }, }, "namespace": { SchemaProps: spec.SchemaProps{ - 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", + 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{"string"}, Format: "", }, @@ -38357,7 +38362,7 @@ func schema_openshift_api_machine_v1beta1_ObjectMeta(ref common.ReferenceCallbac }, "annotations": { SchemaProps: spec.SchemaProps{ - 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", + 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: []string{"object"}, AdditionalProperties: &spec.SchemaOrBool{ Allows: true, @@ -38412,21 +38417,21 @@ func schema_openshift_api_machine_v1beta1_Placement(ref common.ReferenceCallback Properties: map[string]spec.Schema{ "region": { SchemaProps: spec.SchemaProps{ - Description: "Region is the region to use to create the instance", + Description: "region is the region to use to create the instance", Type: []string{"string"}, Format: "", }, }, "availabilityZone": { SchemaProps: spec.SchemaProps{ - Description: "AvailabilityZone is the availability zone of the instance", + Description: "availabilityZone is the availability zone of the instance", Type: []string{"string"}, Format: "", }, }, "tenancy": { SchemaProps: spec.SchemaProps{ - Description: "Tenancy indicates if instance should run on shared or single-tenant hardware. There are supported 3 options: default, dedicated and host.", + Description: "tenancy indicates if instance should run on shared or single-tenant hardware. There are supported 3 options: default, dedicated and host.", Type: []string{"string"}, Format: "", }, @@ -38446,7 +38451,7 @@ func schema_openshift_api_machine_v1beta1_ProviderSpec(ref common.ReferenceCallb Properties: map[string]spec.Schema{ "value": { SchemaProps: spec.SchemaProps{ - 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.", + 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: ref("k8s.io/apimachinery/pkg/runtime.RawExtension"), }, }, @@ -38552,6 +38557,7 @@ func schema_openshift_api_machine_v1beta1_SecuritySettings(ref common.ReferenceC }, }, }, + Required: []string{"securityType"}, }, VendorExtensible: spec.VendorExtensible{ Extensions: spec.Extensions{ @@ -38601,7 +38607,7 @@ func schema_openshift_api_machine_v1beta1_SpotVMOptions(ref common.ReferenceCall Properties: map[string]spec.Schema{ "maxPrice": { SchemaProps: spec.SchemaProps{ - Description: "MaxPrice defines the maximum price the user is willing to pay for Spot VM instances", + Description: "maxPrice defines the maximum price the user is willing to pay for Spot VM instances", Ref: ref("k8s.io/apimachinery/pkg/api/resource.Quantity"), }, }, @@ -38622,7 +38628,7 @@ func schema_openshift_api_machine_v1beta1_TagSpecification(ref common.ReferenceC Properties: map[string]spec.Schema{ "name": { SchemaProps: spec.SchemaProps{ - Description: "Name of the tag", + Description: "name of the tag", Default: "", Type: []string{"string"}, Format: "", @@ -38630,7 +38636,7 @@ func schema_openshift_api_machine_v1beta1_TagSpecification(ref common.ReferenceC }, "value": { SchemaProps: spec.SchemaProps{ - Description: "Value of the tag", + Description: "value of the tag", Default: "", Type: []string{"string"}, Format: "", @@ -38658,6 +38664,7 @@ func schema_openshift_api_machine_v1beta1_TrustedLaunch(ref common.ReferenceCall }, }, }, + Required: []string{"uefiSettings"}, }, }, Dependencies: []string{ @@ -38786,19 +38793,19 @@ func schema_openshift_api_machine_v1beta1_VSphereMachineProviderSpec(ref common. }, "userDataSecret": { SchemaProps: spec.SchemaProps{ - Description: "UserDataSecret contains a local reference to a secret that contains the UserData to apply to the instance", + Description: "userDataSecret contains a local reference to a secret that contains the UserData to apply to the instance", Ref: ref("k8s.io/api/core/v1.LocalObjectReference"), }, }, "credentialsSecret": { SchemaProps: spec.SchemaProps{ - Description: "CredentialsSecret is a reference to the secret with vSphere credentials.", + Description: "credentialsSecret is a reference to the secret with vSphere credentials.", Ref: ref("k8s.io/api/core/v1.LocalObjectReference"), }, }, "template": { SchemaProps: spec.SchemaProps{ - Description: "Template is the name, inventory path, or instance UUID of the template used to clone new machines.", + Description: "template is the name, inventory path, or instance UUID of the template used to clone new machines.", Default: "", Type: []string{"string"}, Format: "", @@ -38806,20 +38813,20 @@ func schema_openshift_api_machine_v1beta1_VSphereMachineProviderSpec(ref common. }, "workspace": { SchemaProps: spec.SchemaProps{ - Description: "Workspace describes the workspace to use for the machine.", + Description: "workspace describes the workspace to use for the machine.", Ref: ref("github.com/openshift/api/machine/v1beta1.Workspace"), }, }, "network": { SchemaProps: spec.SchemaProps{ - Description: "Network is the network configuration for this machine's VM.", + Description: "network is the network configuration for this machine's VM.", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/machine/v1beta1.NetworkSpec"), }, }, "numCPUs": { SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"integer"}, Format: "int32", }, @@ -38833,14 +38840,14 @@ func schema_openshift_api_machine_v1beta1_VSphereMachineProviderSpec(ref common. }, "memoryMiB": { SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"integer"}, Format: "int64", }, }, "diskGiB": { SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"integer"}, Format: "int32", }, @@ -38862,7 +38869,7 @@ func schema_openshift_api_machine_v1beta1_VSphereMachineProviderSpec(ref common. }, "snapshot": { SchemaProps: spec.SchemaProps{ - Description: "Snapshot is the name of the snapshot from which the VM was cloned", + Description: "snapshot is the name of the snapshot from which the VM was cloned", Default: "", Type: []string{"string"}, Format: "", @@ -38870,7 +38877,7 @@ func schema_openshift_api_machine_v1beta1_VSphereMachineProviderSpec(ref common. }, "cloneMode": { SchemaProps: spec.SchemaProps{ - 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.", + 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{"string"}, Format: "", }, @@ -38907,7 +38914,7 @@ func schema_openshift_api_machine_v1beta1_VSphereMachineProviderStatus(ref commo }, "instanceId": { SchemaProps: spec.SchemaProps{ - Description: "InstanceID is the ID of the instance in VSphere", + Description: "instanceId is the ID of the instance in VSphere", Type: []string{"string"}, Format: "", }, @@ -38957,35 +38964,35 @@ func schema_openshift_api_machine_v1beta1_Workspace(ref common.ReferenceCallback Properties: map[string]spec.Schema{ "server": { SchemaProps: spec.SchemaProps{ - Description: "Server is the IP address or FQDN of the vSphere endpoint.", + Description: "server is the IP address or FQDN of the vSphere endpoint.", Type: []string{"string"}, Format: "", }, }, "datacenter": { SchemaProps: spec.SchemaProps{ - Description: "Datacenter is the datacenter in which VMs are created/located.", + Description: "datacenter is the datacenter in which VMs are created/located.", Type: []string{"string"}, Format: "", }, }, "folder": { SchemaProps: spec.SchemaProps{ - Description: "Folder is the folder in which VMs are created/located.", + Description: "folder is the folder in which VMs are created/located.", Type: []string{"string"}, Format: "", }, }, "datastore": { SchemaProps: spec.SchemaProps{ - Description: "Datastore is the datastore in which VMs are created/located.", + Description: "datastore is the datastore in which VMs are created/located.", Type: []string{"string"}, Format: "", }, }, "resourcePool": { SchemaProps: spec.SchemaProps{ - Description: "ResourcePool is the resource pool in which VMs are created/located.", + Description: "resourcePool is the resource pool in which VMs are created/located.", Type: []string{"string"}, Format: "", }, @@ -39438,7 +39445,7 @@ func schema_openshift_api_machineconfiguration_v1alpha1_MachineConfigNodeStatus( }, }, }, - Required: []string{"configVersion"}, + Required: []string{"observedGeneration", "configVersion"}, }, }, Dependencies: []string{ @@ -39796,7 +39803,7 @@ func schema_openshift_api_machineconfiguration_v1alpha1_MachineOSBuilderReferenc Properties: map[string]spec.Schema{ "imageBuilderType": { SchemaProps: spec.SchemaProps{ - Description: "ImageBuilderType describes the image builder set in the MachineOSConfig", + Description: "imageBuilderType describes the image builder set in the MachineOSConfig", Default: "", Type: []string{"string"}, Format: "", @@ -40033,6 +40040,7 @@ func schema_openshift_api_machineconfiguration_v1alpha1_MachineOSConfigStatus(re }, }, }, + Required: []string{"observedGeneration"}, }, }, Dependencies: []string{ @@ -40921,21 +40929,21 @@ func schema_openshift_api_network_v1_ClusterNetwork(ref common.ReferenceCallback }, "network": { SchemaProps: spec.SchemaProps{ - Description: "Network is a CIDR string specifying the global overlay network's L3 space", + Description: "network is a CIDR string specifying the global overlay network's L3 space", Type: []string{"string"}, Format: "", }, }, "hostsubnetlength": { SchemaProps: spec.SchemaProps{ - 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", + 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: []string{"integer"}, Format: "int64", }, }, "serviceNetwork": { SchemaProps: spec.SchemaProps{ - Description: "ServiceNetwork is the CIDR range that Service IP addresses are allocated from", + Description: "serviceNetwork is the CIDR range that Service IP addresses are allocated from", Default: "", Type: []string{"string"}, Format: "", @@ -40943,14 +40951,14 @@ func schema_openshift_api_network_v1_ClusterNetwork(ref common.ReferenceCallback }, "pluginName": { SchemaProps: spec.SchemaProps{ - Description: "PluginName is the name of the network plugin being used", + Description: "pluginName is the name of the network plugin being used", Type: []string{"string"}, Format: "", }, }, "clusterNetworks": { SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -40964,14 +40972,14 @@ func schema_openshift_api_network_v1_ClusterNetwork(ref common.ReferenceCallback }, "vxlanPort": { SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"integer"}, Format: "int64", }, }, "mtu": { SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"integer"}, Format: "int64", }, @@ -41002,7 +41010,7 @@ func schema_openshift_api_network_v1_ClusterNetworkEntry(ref common.ReferenceCal }, "hostSubnetLength": { SchemaProps: spec.SchemaProps{ - 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.", + 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.", Default: 0, Type: []string{"integer"}, Format: "int64", @@ -41045,7 +41053,7 @@ func schema_openshift_api_network_v1_ClusterNetworkList(ref common.ReferenceCall }, "items": { SchemaProps: spec.SchemaProps{ - Description: "Items is the list of cluster networks", + Description: "items is the list of cluster networks", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -41170,14 +41178,14 @@ func schema_openshift_api_network_v1_EgressNetworkPolicyPeer(ref common.Referenc Properties: map[string]spec.Schema{ "cidrSelector": { SchemaProps: spec.SchemaProps{ - 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.", + 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{"string"}, Format: "", }, }, "dnsName": { SchemaProps: spec.SchemaProps{ - Description: "DNSName is the domain name to allow/deny traffic to. If this is set, cidrSelector must be unset", + Description: "dnsName is the domain name to allow/deny traffic to. If this is set, cidrSelector must be unset", Type: []string{"string"}, Format: "", }, @@ -41279,7 +41287,7 @@ func schema_openshift_api_network_v1_HostSubnet(ref common.ReferenceCallback) co }, "host": { SchemaProps: spec.SchemaProps{ - Description: "Host is the name of the node. (This is the same as the object's name, but both fields must be set.)", + Description: "host is the name of the node. (This is the same as the object's name, but both fields must be set.)", Default: "", Type: []string{"string"}, Format: "", @@ -41287,7 +41295,7 @@ func schema_openshift_api_network_v1_HostSubnet(ref common.ReferenceCallback) co }, "hostIP": { SchemaProps: spec.SchemaProps{ - Description: "HostIP is the IP address to be used as a VTEP by other nodes in the overlay network", + Description: "hostIP is the IP address to be used as a VTEP by other nodes in the overlay network", Default: "", Type: []string{"string"}, Format: "", @@ -41295,7 +41303,7 @@ func schema_openshift_api_network_v1_HostSubnet(ref common.ReferenceCallback) co }, "subnet": { SchemaProps: spec.SchemaProps{ - Description: "Subnet is the CIDR range of the overlay network assigned to the node for its pods", + Description: "subnet is the CIDR range of the overlay network assigned to the node for its pods", Default: "", Type: []string{"string"}, Format: "", @@ -41303,7 +41311,7 @@ func schema_openshift_api_network_v1_HostSubnet(ref common.ReferenceCallback) co }, "egressIPs": { SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -41318,7 +41326,7 @@ func schema_openshift_api_network_v1_HostSubnet(ref common.ReferenceCallback) co }, "egressCIDRs": { SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -41370,7 +41378,7 @@ func schema_openshift_api_network_v1_HostSubnetList(ref common.ReferenceCallback }, "items": { SchemaProps: spec.SchemaProps{ - Description: "Items is the list of host subnets", + Description: "items is the list of host subnets", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -41421,7 +41429,7 @@ func schema_openshift_api_network_v1_NetNamespace(ref common.ReferenceCallback) }, "netname": { SchemaProps: spec.SchemaProps{ - Description: "NetName is the name of the network namespace. (This is the same as the object's name, but both fields must be set.)", + Description: "netname is the name of the network namespace. (This is the same as the object's name, but both fields must be set.)", Default: "", Type: []string{"string"}, Format: "", @@ -41429,7 +41437,7 @@ func schema_openshift_api_network_v1_NetNamespace(ref common.ReferenceCallback) }, "netid": { SchemaProps: spec.SchemaProps{ - 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.", + 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.", Default: 0, Type: []string{"integer"}, Format: "int64", @@ -41437,7 +41445,7 @@ func schema_openshift_api_network_v1_NetNamespace(ref common.ReferenceCallback) }, "egressIPs": { SchemaProps: spec.SchemaProps{ - 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.)", + 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: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -41489,7 +41497,7 @@ func schema_openshift_api_network_v1_NetNamespaceList(ref common.ReferenceCallba }, "items": { SchemaProps: spec.SchemaProps{ - Description: "Items is the list of net namespaces", + Description: "items is the list of net namespaces", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -41846,7 +41854,7 @@ func schema_openshift_api_networkoperator_v1_EgressRouterSpec(ref common.Referen Properties: map[string]spec.Schema{ "mode": { SchemaProps: spec.SchemaProps{ - Description: "Mode depicts the mode that is used for the egress router. The default mode is \"Redirect\" and is the only supported mode currently.", + Description: "mode depicts the mode that is used for the egress router. The default mode is \"Redirect\" and is the only supported mode currently.", Default: "", Type: []string{"string"}, Format: "", @@ -41854,7 +41862,7 @@ func schema_openshift_api_networkoperator_v1_EgressRouterSpec(ref common.Referen }, "redirect": { SchemaProps: spec.SchemaProps{ - Description: "Redirect represents the configuration parameters specific to redirect mode.", + Description: "redirect represents the configuration parameters specific to redirect mode.", Ref: ref("github.com/openshift/api/networkoperator/v1.RedirectConfig"), }, }, @@ -41897,7 +41905,7 @@ func schema_openshift_api_oauth_v1_ClusterRoleScopeRestriction(ref common.Refere Properties: map[string]spec.Schema{ "roleNames": { SchemaProps: spec.SchemaProps{ - Description: "RoleNames is the list of cluster roles that can referenced. * means anything", + Description: "roleNames is the list of cluster roles that can referenced. * means anything", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -41912,7 +41920,7 @@ func schema_openshift_api_oauth_v1_ClusterRoleScopeRestriction(ref common.Refere }, "namespaces": { SchemaProps: spec.SchemaProps{ - Description: "Namespaces is the list of namespaces that can be referenced. * means any of them (including *)", + Description: "namespaces is the list of namespaces that can be referenced. * means any of them (including *)", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -41927,7 +41935,7 @@ func schema_openshift_api_oauth_v1_ClusterRoleScopeRestriction(ref common.Refere }, "allowEscalation": { SchemaProps: spec.SchemaProps{ - Description: "AllowEscalation indicates whether you can request roles and their escalating resources", + Description: "allowEscalation indicates whether you can request roles and their escalating resources", Default: false, Type: []string{"boolean"}, Format: "", @@ -41970,21 +41978,21 @@ func schema_openshift_api_oauth_v1_OAuthAccessToken(ref common.ReferenceCallback }, "clientName": { SchemaProps: spec.SchemaProps{ - Description: "ClientName references the client that created this token.", + Description: "clientName references the client that created this token.", Type: []string{"string"}, Format: "", }, }, "expiresIn": { SchemaProps: spec.SchemaProps{ - Description: "ExpiresIn is the seconds from CreationTime before this token expires.", + Description: "expiresIn is the seconds from CreationTime before this token expires.", Type: []string{"integer"}, Format: "int64", }, }, "scopes": { SchemaProps: spec.SchemaProps{ - Description: "Scopes is an array of the requested scopes.", + Description: "scopes is an array of the requested scopes.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -41999,42 +42007,42 @@ func schema_openshift_api_oauth_v1_OAuthAccessToken(ref common.ReferenceCallback }, "redirectURI": { SchemaProps: spec.SchemaProps{ - Description: "RedirectURI is the redirection associated with the token.", + Description: "redirectURI is the redirection associated with the token.", Type: []string{"string"}, Format: "", }, }, "userName": { SchemaProps: spec.SchemaProps{ - Description: "UserName is the user name associated with this token", + Description: "userName is the user name associated with this token", Type: []string{"string"}, Format: "", }, }, "userUID": { SchemaProps: spec.SchemaProps{ - Description: "UserUID is the unique UID associated with this token", + Description: "userUID is the unique UID associated with this token", Type: []string{"string"}, Format: "", }, }, "authorizeToken": { SchemaProps: spec.SchemaProps{ - Description: "AuthorizeToken contains the token that authorized this token", + Description: "authorizeToken contains the token that authorized this token", Type: []string{"string"}, Format: "", }, }, "refreshToken": { SchemaProps: spec.SchemaProps{ - Description: "RefreshToken is the value by which this token can be renewed. Can be blank.", + Description: "refreshToken is the value by which this token can be renewed. Can be blank.", Type: []string{"string"}, Format: "", }, }, "inactivityTimeoutSeconds": { SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"integer"}, Format: "int32", }, @@ -42077,7 +42085,7 @@ func schema_openshift_api_oauth_v1_OAuthAccessTokenList(ref common.ReferenceCall }, "items": { SchemaProps: spec.SchemaProps{ - Description: "Items is the list of OAuth access tokens", + Description: "items is the list of OAuth access tokens", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -42128,21 +42136,21 @@ func schema_openshift_api_oauth_v1_OAuthAuthorizeToken(ref common.ReferenceCallb }, "clientName": { SchemaProps: spec.SchemaProps{ - Description: "ClientName references the client that created this token.", + Description: "clientName references the client that created this token.", Type: []string{"string"}, Format: "", }, }, "expiresIn": { SchemaProps: spec.SchemaProps{ - Description: "ExpiresIn is the seconds from CreationTime before this token expires.", + Description: "expiresIn is the seconds from CreationTime before this token expires.", Type: []string{"integer"}, Format: "int64", }, }, "scopes": { SchemaProps: spec.SchemaProps{ - Description: "Scopes is an array of the requested scopes.", + Description: "scopes is an array of the requested scopes.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -42157,42 +42165,42 @@ func schema_openshift_api_oauth_v1_OAuthAuthorizeToken(ref common.ReferenceCallb }, "redirectURI": { SchemaProps: spec.SchemaProps{ - Description: "RedirectURI is the redirection associated with the token.", + Description: "redirectURI is the redirection associated with the token.", Type: []string{"string"}, Format: "", }, }, "state": { SchemaProps: spec.SchemaProps{ - Description: "State data from request", + Description: "state data from request", Type: []string{"string"}, Format: "", }, }, "userName": { SchemaProps: spec.SchemaProps{ - Description: "UserName is the user name associated with this token", + Description: "userName is the user name associated with this token", Type: []string{"string"}, Format: "", }, }, "userUID": { SchemaProps: spec.SchemaProps{ - Description: "UserUID is the unique UID associated with this token. UserUID and UserName must both match for this token to be valid.", + Description: "userUID is the unique UID associated with this token. UserUID and UserName must both match for this token to be valid.", Type: []string{"string"}, Format: "", }, }, "codeChallenge": { SchemaProps: spec.SchemaProps{ - Description: "CodeChallenge is the optional code_challenge associated with this authorization code, as described in rfc7636", + Description: "codeChallenge is the optional code_challenge associated with this authorization code, as described in rfc7636", Type: []string{"string"}, Format: "", }, }, "codeChallengeMethod": { SchemaProps: spec.SchemaProps{ - Description: "CodeChallengeMethod is the optional code_challenge_method associated with this authorization code, as described in rfc7636", + Description: "codeChallengeMethod is the optional code_challenge_method associated with this authorization code, as described in rfc7636", Type: []string{"string"}, Format: "", }, @@ -42235,7 +42243,7 @@ func schema_openshift_api_oauth_v1_OAuthAuthorizeTokenList(ref common.ReferenceC }, "items": { SchemaProps: spec.SchemaProps{ - Description: "Items is the list of OAuth authorization tokens", + Description: "items is the list of OAuth authorization tokens", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -42286,14 +42294,14 @@ func schema_openshift_api_oauth_v1_OAuthClient(ref common.ReferenceCallback) com }, "secret": { SchemaProps: spec.SchemaProps{ - Description: "Secret is the unique secret associated with a client", + Description: "secret is the unique secret associated with a client", Type: []string{"string"}, Format: "", }, }, "additionalSecrets": { SchemaProps: spec.SchemaProps{ - Description: "AdditionalSecrets holds other secrets that may be used to identify the client. This is useful for rotation and for service account token validation", + 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: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -42308,7 +42316,7 @@ func schema_openshift_api_oauth_v1_OAuthClient(ref common.ReferenceCallback) com }, "respondWithChallenges": { SchemaProps: spec.SchemaProps{ - Description: "RespondWithChallenges indicates whether the client wants authentication needed responses made in the form of challenges instead of redirects", + Description: "respondWithChallenges indicates whether the client wants authentication needed responses made in the form of challenges instead of redirects", Type: []string{"boolean"}, Format: "", }, @@ -42320,7 +42328,7 @@ func schema_openshift_api_oauth_v1_OAuthClient(ref common.ReferenceCallback) com }, }, SchemaProps: spec.SchemaProps{ - Description: "RedirectURIs is the valid redirection URIs associated with a client", + Description: "redirectURIs is the valid redirection URIs associated with a client", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -42335,14 +42343,14 @@ func schema_openshift_api_oauth_v1_OAuthClient(ref common.ReferenceCallback) com }, "grantMethod": { SchemaProps: spec.SchemaProps{ - 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", + 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{"string"}, Format: "", }, }, "scopeRestrictions": { SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -42356,14 +42364,14 @@ func schema_openshift_api_oauth_v1_OAuthClient(ref common.ReferenceCallback) com }, "accessTokenMaxAgeSeconds": { SchemaProps: spec.SchemaProps{ - Description: "AccessTokenMaxAgeSeconds overrides the default access token max age for tokens granted to this client. 0 means no expiration.", + Description: "accessTokenMaxAgeSeconds overrides the default access token max age for tokens granted to this client. 0 means no expiration.", Type: []string{"integer"}, Format: "int32", }, }, "accessTokenInactivityTimeoutSeconds": { SchemaProps: spec.SchemaProps{ - 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", + 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: []string{"integer"}, Format: "int32", }, @@ -42406,28 +42414,28 @@ func schema_openshift_api_oauth_v1_OAuthClientAuthorization(ref common.Reference }, "clientName": { SchemaProps: spec.SchemaProps{ - Description: "ClientName references the client that created this authorization", + Description: "clientName references the client that created this authorization", Type: []string{"string"}, Format: "", }, }, "userName": { SchemaProps: spec.SchemaProps{ - Description: "UserName is the user name that authorized this client", + Description: "userName is the user name that authorized this client", Type: []string{"string"}, Format: "", }, }, "userUID": { SchemaProps: spec.SchemaProps{ - Description: "UserUID is the unique UID associated with this authorization. UserUID and UserName must both match for this authorization to be valid.", + Description: "userUID is the unique UID associated with this authorization. UserUID and UserName must both match for this authorization to be valid.", Type: []string{"string"}, Format: "", }, }, "scopes": { SchemaProps: spec.SchemaProps{ - Description: "Scopes is an array of the granted scopes.", + Description: "scopes is an array of the granted scopes.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -42478,7 +42486,7 @@ func schema_openshift_api_oauth_v1_OAuthClientAuthorizationList(ref common.Refer }, "items": { SchemaProps: spec.SchemaProps{ - Description: "Items is the list of OAuth client authorizations", + Description: "items is the list of OAuth client authorizations", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -42529,7 +42537,7 @@ func schema_openshift_api_oauth_v1_OAuthClientList(ref common.ReferenceCallback) }, "items": { SchemaProps: spec.SchemaProps{ - Description: "Items is the list of OAuth clients", + Description: "items is the list of OAuth clients", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -42655,7 +42663,7 @@ func schema_openshift_api_oauth_v1_ScopeRestriction(ref common.ReferenceCallback }, "clusterRole": { SchemaProps: spec.SchemaProps{ - Description: "ClusterRole describes a set of restrictions for cluster role scoping.", + Description: "clusterRole describes a set of restrictions for cluster role scoping.", Ref: ref("github.com/openshift/api/oauth/v1.ClusterRoleScopeRestriction"), }, }, @@ -42697,21 +42705,21 @@ func schema_openshift_api_oauth_v1_UserOAuthAccessToken(ref common.ReferenceCall }, "clientName": { SchemaProps: spec.SchemaProps{ - Description: "ClientName references the client that created this token.", + Description: "clientName references the client that created this token.", Type: []string{"string"}, Format: "", }, }, "expiresIn": { SchemaProps: spec.SchemaProps{ - Description: "ExpiresIn is the seconds from CreationTime before this token expires.", + Description: "expiresIn is the seconds from CreationTime before this token expires.", Type: []string{"integer"}, Format: "int64", }, }, "scopes": { SchemaProps: spec.SchemaProps{ - Description: "Scopes is an array of the requested scopes.", + Description: "scopes is an array of the requested scopes.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -42726,42 +42734,42 @@ func schema_openshift_api_oauth_v1_UserOAuthAccessToken(ref common.ReferenceCall }, "redirectURI": { SchemaProps: spec.SchemaProps{ - Description: "RedirectURI is the redirection associated with the token.", + Description: "redirectURI is the redirection associated with the token.", Type: []string{"string"}, Format: "", }, }, "userName": { SchemaProps: spec.SchemaProps{ - Description: "UserName is the user name associated with this token", + Description: "userName is the user name associated with this token", Type: []string{"string"}, Format: "", }, }, "userUID": { SchemaProps: spec.SchemaProps{ - Description: "UserUID is the unique UID associated with this token", + Description: "userUID is the unique UID associated with this token", Type: []string{"string"}, Format: "", }, }, "authorizeToken": { SchemaProps: spec.SchemaProps{ - Description: "AuthorizeToken contains the token that authorized this token", + Description: "authorizeToken contains the token that authorized this token", Type: []string{"string"}, Format: "", }, }, "refreshToken": { SchemaProps: spec.SchemaProps{ - Description: "RefreshToken is the value by which this token can be renewed. Can be blank.", + Description: "refreshToken is the value by which this token can be renewed. Can be blank.", Type: []string{"string"}, Format: "", }, }, "inactivityTimeoutSeconds": { SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"integer"}, Format: "int32", }, @@ -43120,7 +43128,7 @@ func schema_openshift_api_openshiftcontrolplane_v1_ClusterNetworkEntry(ref commo Properties: map[string]spec.Schema{ "cidr": { SchemaProps: spec.SchemaProps{ - Description: "CIDR defines the total range of a cluster networks address space.", + Description: "cidr defines the total range of a cluster networks address space.", Default: "", Type: []string{"string"}, Format: "", @@ -43128,7 +43136,7 @@ func schema_openshift_api_openshiftcontrolplane_v1_ClusterNetworkEntry(ref commo }, "hostSubnetLength": { SchemaProps: spec.SchemaProps{ - 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.", + 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.", Default: 0, Type: []string{"integer"}, Format: "int64", @@ -43288,7 +43296,7 @@ func schema_openshift_api_openshiftcontrolplane_v1_ImageConfig(ref common.Refere Properties: map[string]spec.Schema{ "format": { SchemaProps: spec.SchemaProps{ - Description: "Format is the format of the name to be built for the system component", + Description: "format is the format of the name to be built for the system component", Default: "", Type: []string{"string"}, Format: "", @@ -43296,7 +43304,7 @@ func schema_openshift_api_openshiftcontrolplane_v1_ImageConfig(ref common.Refere }, "latest": { SchemaProps: spec.SchemaProps{ - Description: "Latest determines if the latest tag will be pulled from the registry", + Description: "latest determines if the latest tag will be pulled from the registry", Default: false, Type: []string{"boolean"}, Format: "", @@ -43951,7 +43959,7 @@ func schema_openshift_api_openshiftcontrolplane_v1_RegistryLocation(ref common.R Properties: map[string]spec.Schema{ "domainName": { SchemaProps: spec.SchemaProps{ - 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.", + 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.", Default: "", Type: []string{"string"}, Format: "", @@ -43959,7 +43967,7 @@ func schema_openshift_api_openshiftcontrolplane_v1_RegistryLocation(ref common.R }, "insecure": { SchemaProps: spec.SchemaProps{ - Description: "Insecure indicates whether the registry is secure (https) or insecure (http) By default (if not specified) the registry is assumed as secure.", + Description: "insecure indicates whether the registry is secure (https) or insecure (http) By default (if not specified) the registry is assumed as secure.", Type: []string{"boolean"}, Format: "", }, @@ -44034,7 +44042,7 @@ func schema_openshift_api_openshiftcontrolplane_v1_SecurityAllocator(ref common. Properties: map[string]spec.Schema{ "uidAllocatorRange": { SchemaProps: spec.SchemaProps{ - 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).", + 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).", Default: "", Type: []string{"string"}, Format: "", @@ -44042,7 +44050,7 @@ func schema_openshift_api_openshiftcontrolplane_v1_SecurityAllocator(ref common. }, "mcsAllocatorRange": { SchemaProps: spec.SchemaProps{ - 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", + 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", Default: "", Type: []string{"string"}, Format: "", @@ -44050,7 +44058,7 @@ func schema_openshift_api_openshiftcontrolplane_v1_SecurityAllocator(ref common. }, "mcsLabelsPerProject": { SchemaProps: spec.SchemaProps{ - 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).", + 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).", Default: 0, Type: []string{"integer"}, Format: "int32", @@ -44100,7 +44108,7 @@ func schema_openshift_api_openshiftcontrolplane_v1_ServiceServingCert(ref common Properties: map[string]spec.Schema{ "signer": { SchemaProps: spec.SchemaProps{ - Description: "Signer holds the signing information used to automatically sign serving certificates. If this value is nil, then certs are not signed automatically.", + Description: "signer holds the signing information used to automatically sign serving certificates. If this value is nil, then certs are not signed automatically.", Ref: ref("github.com/openshift/api/config/v1.CertInfo"), }, }, @@ -44530,7 +44538,7 @@ func schema_openshift_api_operator_v1_AdditionalNetworkDefinition(ref common.Ref }, "simpleMacvlanConfig": { SchemaProps: spec.SchemaProps{ - Description: "SimpleMacvlanConfig configures the macvlan interface in case of type:NetworkTypeSimpleMacvlan", + Description: "simpleMacvlanConfig configures the macvlan interface in case of type:NetworkTypeSimpleMacvlan", Ref: ref("github.com/openshift/api/operator/v1.SimpleMacvlanConfig"), }, }, @@ -44733,7 +44741,7 @@ func schema_openshift_api_operator_v1_AuthenticationStatus(ref common.ReferenceC Properties: map[string]spec.Schema{ "oauthAPIServer": { SchemaProps: spec.SchemaProps{ - Description: "OAuthAPIServer holds status specific only to oauth-apiserver", + Description: "oauthAPIServer holds status specific only to oauth-apiserver", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/operator/v1.OAuthAPIServerStatus"), }, @@ -44923,7 +44931,7 @@ func schema_openshift_api_operator_v1_CSIDriverConfigSpec(ref common.ReferenceCa }, "vSphere": { SchemaProps: spec.SchemaProps{ - Description: "vsphere is used to configure the vsphere CSI driver.", + Description: "vSphere is used to configure the vsphere CSI driver.", Ref: ref("github.com/openshift/api/operator/v1.VSphereCSIDriverConfigSpec"), }, }, @@ -45451,7 +45459,7 @@ func schema_openshift_api_operator_v1_CloudCredentialSpec(ref common.ReferenceCa }, "credentialsMode": { SchemaProps: spec.SchemaProps{ - 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\"", + 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{"string"}, Format: "", }, @@ -45701,7 +45709,7 @@ func schema_openshift_api_operator_v1_ClusterCSIDriverSpec(ref common.ReferenceC }, "storageClassState": { SchemaProps: spec.SchemaProps{ - 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.", + 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{"string"}, Format: "", }, @@ -45922,7 +45930,7 @@ func schema_openshift_api_operator_v1_ConfigList(ref common.ReferenceCallback) c }, "items": { SchemaProps: spec.SchemaProps{ - Description: "Items contains the items", + Description: "items contains the items", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -46937,7 +46945,7 @@ func schema_openshift_api_operator_v1_DefaultNetworkDefinition(ref common.Refere }, "openshiftSDNConfig": { SchemaProps: spec.SchemaProps{ - Description: "openShiftSDNConfig was previously used to configure the openshift-sdn plugin. DEPRECATED: OpenShift SDN is no longer supported.", + Description: "openshiftSDNConfig was previously used to configure the openshift-sdn plugin. DEPRECATED: OpenShift SDN is no longer supported.", Ref: ref("github.com/openshift/api/operator/v1.OpenShiftSDNConfig"), }, }, @@ -46965,7 +46973,7 @@ func schema_openshift_api_operator_v1_DeveloperConsoleCatalogCategory(ref common Properties: map[string]spec.Schema{ "id": { SchemaProps: spec.SchemaProps{ - 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.", + 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.", Default: "", Type: []string{"string"}, Format: "", @@ -47026,7 +47034,7 @@ func schema_openshift_api_operator_v1_DeveloperConsoleCatalogCategoryMeta(ref co Properties: map[string]spec.Schema{ "id": { SchemaProps: spec.SchemaProps{ - 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.", + 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.", Default: "", Type: []string{"string"}, Format: "", @@ -47154,6 +47162,7 @@ func schema_openshift_api_operator_v1_DeveloperConsoleCatalogTypes(ref common.Re }, }, }, + Required: []string{"state"}, }, VendorExtensible: spec.VendorExtensible{ Extensions: spec.Extensions{ @@ -47334,7 +47343,7 @@ func schema_openshift_api_operator_v1_EtcdList(ref common.ReferenceCallback) com }, "items": { SchemaProps: spec.SchemaProps{ - Description: "Items contains the items", + Description: "items contains the items", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -47785,7 +47794,7 @@ func schema_openshift_api_operator_v1_GatewayConfig(ref common.ReferenceCallback Properties: map[string]spec.Schema{ "routingViaHost": { SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"boolean"}, Format: "", }, @@ -48109,7 +48118,7 @@ func schema_openshift_api_operator_v1_HybridOverlayConfig(ref common.ReferenceCa }, }, SchemaProps: spec.SchemaProps{ - Description: "HybridClusterNetwork defines a network space given to nodes on an additional overlay network.", + Description: "hybridClusterNetwork defines a network space given to nodes on an additional overlay network.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -48123,7 +48132,7 @@ func schema_openshift_api_operator_v1_HybridOverlayConfig(ref common.ReferenceCa }, "hybridOverlayVXLANPort": { SchemaProps: spec.SchemaProps{ - Description: "HybridOverlayVXLANPort defines the VXLAN port number to be used by the additional overlay network. Default is 4789", + Description: "hybridOverlayVXLANPort defines the VXLAN port number to be used by the additional overlay network. Default is 4789", Type: []string{"integer"}, Format: "int64", }, @@ -48188,7 +48197,7 @@ func schema_openshift_api_operator_v1_IPAMConfig(ref common.ReferenceCallback) c Properties: map[string]spec.Schema{ "type": { SchemaProps: spec.SchemaProps{ - Description: "Type is the type of IPAM module will be used for IP Address Management(IPAM). The supported values are IPAMTypeDHCP, IPAMTypeStatic", + Description: "type is the type of IPAM module will be used for IP Address Management(IPAM). The supported values are IPAMTypeDHCP, IPAMTypeStatic", Default: "", Type: []string{"string"}, Format: "", @@ -48196,7 +48205,7 @@ func schema_openshift_api_operator_v1_IPAMConfig(ref common.ReferenceCallback) c }, "staticIPAMConfig": { SchemaProps: spec.SchemaProps{ - Description: "StaticIPAMConfig configures the static IP address in case of type:IPAMTypeStatic", + Description: "staticIPAMConfig configures the static IP address in case of type:IPAMTypeStatic", Ref: ref("github.com/openshift/api/operator/v1.StaticIPAMConfig"), }, }, @@ -49207,7 +49216,7 @@ func schema_openshift_api_operator_v1_IngressControllerTuningOptions(ref common. }, "connectTimeout": { SchemaProps: spec.SchemaProps{ - 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.", + 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: ref("k8s.io/apimachinery/pkg/apis/meta/v1.Duration"), }, }, @@ -49620,7 +49629,7 @@ func schema_openshift_api_operator_v1_KubeAPIServerList(ref common.ReferenceCall }, "items": { SchemaProps: spec.SchemaProps{ - Description: "Items contains the items", + Description: "items contains the items", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -49927,7 +49936,7 @@ func schema_openshift_api_operator_v1_KubeControllerManagerList(ref common.Refer }, "items": { SchemaProps: spec.SchemaProps{ - Description: "Items contains the items", + Description: "items contains the items", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -50228,7 +50237,7 @@ func schema_openshift_api_operator_v1_KubeSchedulerList(ref common.ReferenceCall }, "items": { SchemaProps: spec.SchemaProps{ - Description: "Items contains the items", + Description: "items contains the items", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -50519,7 +50528,7 @@ func schema_openshift_api_operator_v1_KubeStorageVersionMigratorList(ref common. }, "items": { SchemaProps: spec.SchemaProps{ - Description: "Items contains the items", + Description: "items contains the items", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -50730,7 +50739,7 @@ func schema_openshift_api_operator_v1_LoadBalancerStrategy(ref common.ReferenceC }, }, }, - Required: []string{"scope"}, + Required: []string{"scope", "dnsManagementPolicy"}, }, }, Dependencies: []string{ @@ -50923,7 +50932,7 @@ func schema_openshift_api_operator_v1_MachineConfigurationList(ref common.Refere }, "items": { SchemaProps: spec.SchemaProps{ - Description: "Items contains the items", + Description: "items contains the items", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -52473,7 +52482,7 @@ func schema_openshift_api_operator_v1_OAuthAPIServerStatus(ref common.ReferenceC Properties: map[string]spec.Schema{ "latestAvailableRevision": { SchemaProps: spec.SchemaProps{ - Description: "LatestAvailableRevision is the latest revision used as suffix of revisioned secrets like encryption-config. A new revision causes a new deployment of pods.", + Description: "latestAvailableRevision is the latest revision used as suffix of revisioned secrets like encryption-config. A new revision causes a new deployment of pods.", Type: []string{"integer"}, Format: "int32", }, @@ -52565,7 +52574,7 @@ func schema_openshift_api_operator_v1_OLMList(ref common.ReferenceCallback) comm }, "items": { SchemaProps: spec.SchemaProps{ - Description: "Items contains the items", + Description: "items contains the items", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -52749,7 +52758,7 @@ func schema_openshift_api_operator_v1_OVNKubernetesConfig(ref common.ReferenceCa }, "hybridOverlayConfig": { SchemaProps: spec.SchemaProps{ - Description: "HybridOverlayConfig configures an additional overlay network for peers that are not using OVN.", + Description: "hybridOverlayConfig configures an additional overlay network for peers that are not using OVN.", Ref: ref("github.com/openshift/api/operator/v1.HybridOverlayConfig"), }, }, @@ -52901,7 +52910,7 @@ func schema_openshift_api_operator_v1_OpenShiftAPIServerList(ref common.Referenc }, "items": { SchemaProps: spec.SchemaProps{ - Description: "Items contains the items", + Description: "items contains the items", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -53141,7 +53150,7 @@ func schema_openshift_api_operator_v1_OpenShiftControllerManagerList(ref common. }, "items": { SchemaProps: spec.SchemaProps{ - Description: "Items contains the items", + Description: "items contains the items", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -53577,6 +53586,7 @@ func schema_openshift_api_operator_v1_PartialSelector(ref common.ReferenceCallba }, }, }, + Required: []string{"machineResourceSelector"}, }, }, Dependencies: []string{ @@ -54247,7 +54257,7 @@ func schema_openshift_api_operator_v1_ServiceCAList(ref common.ReferenceCallback }, "items": { SchemaProps: spec.SchemaProps{ - Description: "Items contains the items", + Description: "items contains the items", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -54487,7 +54497,7 @@ func schema_openshift_api_operator_v1_ServiceCatalogAPIServerList(ref common.Ref }, "items": { SchemaProps: spec.SchemaProps{ - Description: "Items contains the items", + Description: "items contains the items", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -54727,7 +54737,7 @@ func schema_openshift_api_operator_v1_ServiceCatalogControllerManagerList(ref co }, "items": { SchemaProps: spec.SchemaProps{ - Description: "Items contains the items", + Description: "items contains the items", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -54904,7 +54914,7 @@ func schema_openshift_api_operator_v1_SimpleMacvlanConfig(ref common.ReferenceCa }, "ipamConfig": { SchemaProps: spec.SchemaProps{ - Description: "IPAMConfig configures IPAM module will be used for IP Address Management (IPAM).", + Description: "ipamConfig configures IPAM module will be used for IP Address Management (IPAM).", Ref: ref("github.com/openshift/api/operator/v1.IPAMConfig"), }, }, @@ -54939,7 +54949,7 @@ func schema_openshift_api_operator_v1_StaticIPAMAddresses(ref common.ReferenceCa Properties: map[string]spec.Schema{ "address": { SchemaProps: spec.SchemaProps{ - Description: "Address is the IP address in CIDR format", + Description: "address is the IP address in CIDR format", Default: "", Type: []string{"string"}, Format: "", @@ -54947,7 +54957,7 @@ func schema_openshift_api_operator_v1_StaticIPAMAddresses(ref common.ReferenceCa }, "gateway": { SchemaProps: spec.SchemaProps{ - Description: "Gateway is IP inside of subnet to designate as the gateway", + Description: "gateway is IP inside of subnet to designate as the gateway", Type: []string{"string"}, Format: "", }, @@ -54972,7 +54982,7 @@ func schema_openshift_api_operator_v1_StaticIPAMConfig(ref common.ReferenceCallb }, }, SchemaProps: spec.SchemaProps{ - Description: "Addresses configures IP address for the interface", + Description: "addresses configures IP address for the interface", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -54991,7 +55001,7 @@ func schema_openshift_api_operator_v1_StaticIPAMConfig(ref common.ReferenceCallb }, }, SchemaProps: spec.SchemaProps{ - Description: "Routes configures IP routes for the interface", + Description: "routes configures IP routes for the interface", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -55005,7 +55015,7 @@ func schema_openshift_api_operator_v1_StaticIPAMConfig(ref common.ReferenceCallb }, "dns": { SchemaProps: spec.SchemaProps{ - Description: "DNS configures DNS for the interface", + Description: "dns configures DNS for the interface", Ref: ref("github.com/openshift/api/operator/v1.StaticIPAMDNS"), }, }, @@ -55031,7 +55041,7 @@ func schema_openshift_api_operator_v1_StaticIPAMDNS(ref common.ReferenceCallback }, }, SchemaProps: spec.SchemaProps{ - Description: "Nameservers points DNS servers for IP lookup", + Description: "nameservers points DNS servers for IP lookup", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -55046,7 +55056,7 @@ func schema_openshift_api_operator_v1_StaticIPAMDNS(ref common.ReferenceCallback }, "domain": { SchemaProps: spec.SchemaProps{ - Description: "Domain configures the domainname the local domain used for short hostname lookups", + Description: "domain configures the domainname the local domain used for short hostname lookups", Type: []string{"string"}, Format: "", }, @@ -55058,7 +55068,7 @@ func schema_openshift_api_operator_v1_StaticIPAMDNS(ref common.ReferenceCallback }, }, SchemaProps: spec.SchemaProps{ - Description: "Search configures priority ordered search domains for short hostname lookups", + Description: "search configures priority ordered search domains for short hostname lookups", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -55086,7 +55096,7 @@ func schema_openshift_api_operator_v1_StaticIPAMRoutes(ref common.ReferenceCallb Properties: map[string]spec.Schema{ "destination": { SchemaProps: spec.SchemaProps{ - Description: "Destination points the IP route destination", + Description: "destination points the IP route destination", Default: "", Type: []string{"string"}, Format: "", @@ -55094,7 +55104,7 @@ func schema_openshift_api_operator_v1_StaticIPAMRoutes(ref common.ReferenceCallb }, "gateway": { SchemaProps: spec.SchemaProps{ - Description: "Gateway is the route's next-hop IP address If unset, a default gateway is assumed (as determined by the CNI plugin).", + 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{"string"}, Format: "", }, @@ -55465,7 +55475,7 @@ func schema_openshift_api_operator_v1_StorageSpec(ref common.ReferenceCallback) }, "vsphereStorageDriver": { SchemaProps: spec.SchemaProps{ - 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.", + 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.", Default: "", Type: []string{"string"}, Format: "", @@ -55625,7 +55635,7 @@ func schema_openshift_api_operator_v1_Upstream(ref common.ReferenceCallback) com Properties: map[string]spec.Schema{ "type": { SchemaProps: spec.SchemaProps{ - 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", + 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", Default: "", Type: []string{"string"}, Format: "", @@ -55633,14 +55643,14 @@ func schema_openshift_api_operator_v1_Upstream(ref common.ReferenceCallback) com }, "address": { SchemaProps: spec.SchemaProps{ - 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.", + 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{"string"}, Format: "", }, }, "port": { SchemaProps: spec.SchemaProps{ - Description: "Port may be defined when Type is set to Network. It will be ignored otherwise. Port must be between 65535", + Description: "port may be defined when Type is set to Network. It will be ignored otherwise. Port must be between 65535", Type: []string{"integer"}, Format: "int64", }, @@ -55661,7 +55671,7 @@ func schema_openshift_api_operator_v1_UpstreamResolvers(ref common.ReferenceCall Properties: map[string]spec.Schema{ "upstreams": { SchemaProps: spec.SchemaProps{ - 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", + 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", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -55675,7 +55685,7 @@ func schema_openshift_api_operator_v1_UpstreamResolvers(ref common.ReferenceCall }, "policy": { SchemaProps: spec.SchemaProps{ - 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\"", + 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{"string"}, Format: "", }, @@ -55934,7 +55944,7 @@ func schema_openshift_api_operator_v1alpha1_EtcdBackupSpec(ref common.ReferenceC Properties: map[string]spec.Schema{ "pvcName": { SchemaProps: spec.SchemaProps{ - 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.", + 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.", Default: "", Type: []string{"string"}, Format: "", @@ -55983,7 +55993,6 @@ func schema_openshift_api_operator_v1alpha1_EtcdBackupStatus(ref common.Referenc }, }, }, - Required: []string{"backupJob"}, }, }, Dependencies: []string{ @@ -56068,7 +56077,7 @@ func schema_openshift_api_operator_v1alpha1_GenericOperatorConfig(ref common.Ref }, "servingInfo": { SchemaProps: spec.SchemaProps{ - Description: "ServingInfo is the HTTP serving information for the controller's endpoints", + Description: "servingInfo is the HTTP serving information for the controller's endpoints", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/config/v1.HTTPServingInfo"), }, @@ -56397,7 +56406,7 @@ func schema_openshift_api_operator_v1alpha1_OLMList(ref common.ReferenceCallback }, "items": { SchemaProps: spec.SchemaProps{ - Description: "Items contains the items", + Description: "items contains the items", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -56928,7 +56937,7 @@ func schema_openshift_api_operatorcontrolplane_v1alpha1_LogEntry(ref common.Refe }, "success": { SchemaProps: spec.SchemaProps{ - Description: "Success indicates if the log entry indicates a success or failure.", + Description: "success indicates if the log entry indicates a success or failure.", Default: false, Type: []string{"boolean"}, Format: "", @@ -56936,21 +56945,21 @@ func schema_openshift_api_operatorcontrolplane_v1alpha1_LogEntry(ref common.Refe }, "reason": { SchemaProps: spec.SchemaProps{ - Description: "Reason for status in a machine readable format.", + Description: "reason for status in a machine readable format.", Type: []string{"string"}, Format: "", }, }, "message": { SchemaProps: spec.SchemaProps{ - Description: "Message explaining status in a human readable format.", + Description: "message explaining status in a human readable format.", Type: []string{"string"}, Format: "", }, }, "latency": { SchemaProps: spec.SchemaProps{ - Description: "Latency records how long the action mentioned in the entry took.", + Description: "latency records how long the action mentioned in the entry took.", Ref: ref("k8s.io/apimachinery/pkg/apis/meta/v1.Duration"), }, }, @@ -56972,19 +56981,19 @@ func schema_openshift_api_operatorcontrolplane_v1alpha1_OutageEntry(ref common.R Properties: map[string]spec.Schema{ "start": { SchemaProps: spec.SchemaProps{ - Description: "Start of outage detected", + Description: "start of outage detected", Ref: ref("k8s.io/apimachinery/pkg/apis/meta/v1.Time"), }, }, "end": { SchemaProps: spec.SchemaProps{ - Description: "End of outage detected", + Description: "end of outage detected", Ref: ref("k8s.io/apimachinery/pkg/apis/meta/v1.Time"), }, }, "startLogs": { SchemaProps: spec.SchemaProps{ - Description: "StartLogs contains log entries related to the start of this outage. Should contain the original failure, any entries where the failure mode changed.", + 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: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -56998,7 +57007,7 @@ func schema_openshift_api_operatorcontrolplane_v1alpha1_OutageEntry(ref common.R }, "endLogs": { SchemaProps: spec.SchemaProps{ - 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.", + 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.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -57056,14 +57065,14 @@ func schema_openshift_api_operatorcontrolplane_v1alpha1_PodNetworkConnectivityCh }, "spec": { SchemaProps: spec.SchemaProps{ - Description: "Spec defines the source and target of the connectivity check", + Description: "spec defines the source and target of the connectivity check", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/operatorcontrolplane/v1alpha1.PodNetworkConnectivityCheckSpec"), }, }, "status": { SchemaProps: spec.SchemaProps{ - Description: "Status contains the observed status of the connectivity check", + Description: "status contains the observed status of the connectivity check", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/operatorcontrolplane/v1alpha1.PodNetworkConnectivityCheckStatus"), }, @@ -57188,7 +57197,7 @@ func schema_openshift_api_operatorcontrolplane_v1alpha1_PodNetworkConnectivityCh Properties: map[string]spec.Schema{ "sourcePod": { SchemaProps: spec.SchemaProps{ - Description: "SourcePod names the pod from which the condition will be checked", + Description: "sourcePod names the pod from which the condition will be checked", Default: "", Type: []string{"string"}, Format: "", @@ -57226,7 +57235,7 @@ func schema_openshift_api_operatorcontrolplane_v1alpha1_PodNetworkConnectivityCh Properties: map[string]spec.Schema{ "successes": { SchemaProps: spec.SchemaProps{ - Description: "Successes contains logs successful check actions", + Description: "successes contains logs successful check actions", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -57240,7 +57249,7 @@ func schema_openshift_api_operatorcontrolplane_v1alpha1_PodNetworkConnectivityCh }, "failures": { SchemaProps: spec.SchemaProps{ - Description: "Failures contains logs of unsuccessful check actions", + Description: "failures contains logs of unsuccessful check actions", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -57254,7 +57263,7 @@ func schema_openshift_api_operatorcontrolplane_v1alpha1_PodNetworkConnectivityCh }, "outages": { SchemaProps: spec.SchemaProps{ - Description: "Outages contains logs of time periods of outages", + Description: "outages contains logs of time periods of outages", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -57274,7 +57283,7 @@ func schema_openshift_api_operatorcontrolplane_v1alpha1_PodNetworkConnectivityCh }, }, SchemaProps: spec.SchemaProps{ - Description: "Conditions summarize the status of the check", + Description: "conditions summarize the status of the check", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -57450,7 +57459,7 @@ func schema_openshift_api_operatoringress_v1_DNSRecordSpec(ref common.ReferenceC }, }, }, - Required: []string{"dnsName", "targets", "recordType", "recordTTL"}, + Required: []string{"dnsName", "targets", "recordType", "recordTTL", "dnsManagementPolicy"}, }, }, } @@ -57626,7 +57635,7 @@ func schema_openshift_api_osin_v1_BasicAuthPasswordIdentityProvider(ref common.R }, "url": { SchemaProps: spec.SchemaProps{ - Description: "URL is the remote URL to connect to", + Description: "url is the remote URL to connect to", Default: "", Type: []string{"string"}, Format: "", @@ -57634,7 +57643,7 @@ func schema_openshift_api_osin_v1_BasicAuthPasswordIdentityProvider(ref common.R }, "ca": { SchemaProps: spec.SchemaProps{ - Description: "CA is the CA for verifying TLS connections", + Description: "ca is the CA for verifying TLS connections", Default: "", Type: []string{"string"}, Format: "", @@ -57642,7 +57651,7 @@ func schema_openshift_api_osin_v1_BasicAuthPasswordIdentityProvider(ref common.R }, "certFile": { SchemaProps: spec.SchemaProps{ - Description: "CertFile is a file containing a PEM-encoded certificate", + Description: "certFile is a file containing a PEM-encoded certificate", Default: "", Type: []string{"string"}, Format: "", @@ -57650,7 +57659,7 @@ func schema_openshift_api_osin_v1_BasicAuthPasswordIdentityProvider(ref common.R }, "keyFile": { SchemaProps: spec.SchemaProps{ - Description: "KeyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile", + Description: "keyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile", Default: "", Type: []string{"string"}, Format: "", @@ -58042,7 +58051,7 @@ func schema_openshift_api_osin_v1_KeystonePasswordIdentityProvider(ref common.Re }, "url": { SchemaProps: spec.SchemaProps{ - Description: "URL is the remote URL to connect to", + Description: "url is the remote URL to connect to", Default: "", Type: []string{"string"}, Format: "", @@ -58050,7 +58059,7 @@ func schema_openshift_api_osin_v1_KeystonePasswordIdentityProvider(ref common.Re }, "ca": { SchemaProps: spec.SchemaProps{ - Description: "CA is the CA for verifying TLS connections", + Description: "ca is the CA for verifying TLS connections", Default: "", Type: []string{"string"}, Format: "", @@ -58058,7 +58067,7 @@ func schema_openshift_api_osin_v1_KeystonePasswordIdentityProvider(ref common.Re }, "certFile": { SchemaProps: spec.SchemaProps{ - Description: "CertFile is a file containing a PEM-encoded certificate", + Description: "certFile is a file containing a PEM-encoded certificate", Default: "", Type: []string{"string"}, Format: "", @@ -58066,7 +58075,7 @@ func schema_openshift_api_osin_v1_KeystonePasswordIdentityProvider(ref common.Re }, "keyFile": { SchemaProps: spec.SchemaProps{ - Description: "KeyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile", + Description: "keyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile", Default: "", Type: []string{"string"}, Format: "", @@ -58869,7 +58878,7 @@ func schema_openshift_api_osin_v1_SessionSecret(ref common.ReferenceCallback) co Properties: map[string]spec.Schema{ "authentication": { SchemaProps: spec.SchemaProps{ - Description: "Authentication is used to authenticate sessions using HMAC. Recommended to use a secret with 32 or 64 bytes.", + Description: "authentication is used to authenticate sessions using HMAC. Recommended to use a secret with 32 or 64 bytes.", Default: "", Type: []string{"string"}, Format: "", @@ -58877,7 +58886,7 @@ func schema_openshift_api_osin_v1_SessionSecret(ref common.ReferenceCallback) co }, "encryption": { SchemaProps: spec.SchemaProps{ - Description: "Encryption is used to encrypt sessions. Must be 16, 24, or 32 characters long, to select AES-128, AES-", + Description: "encryption is used to encrypt sessions. Must be 16, 24, or 32 characters long, to select AES-128, AES-", Default: "", Type: []string{"string"}, Format: "", @@ -58913,7 +58922,7 @@ func schema_openshift_api_osin_v1_SessionSecrets(ref common.ReferenceCallback) c }, "secrets": { SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -59218,14 +59227,14 @@ func schema_openshift_api_project_v1_Project(ref common.ReferenceCallback) commo }, "spec": { SchemaProps: spec.SchemaProps{ - Description: "Spec defines the behavior of the Namespace.", + Description: "spec defines the behavior of the Namespace.", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/project/v1.ProjectSpec"), }, }, "status": { SchemaProps: spec.SchemaProps{ - Description: "Status describes the current status of a Namespace", + Description: "status describes the current status of a Namespace", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/project/v1.ProjectStatus"), }, @@ -59268,7 +59277,7 @@ func schema_openshift_api_project_v1_ProjectList(ref common.ReferenceCallback) c }, "items": { SchemaProps: spec.SchemaProps{ - Description: "Items is the list of projects", + Description: "items is the list of projects", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -59319,14 +59328,14 @@ func schema_openshift_api_project_v1_ProjectRequest(ref common.ReferenceCallback }, "displayName": { SchemaProps: spec.SchemaProps{ - Description: "DisplayName is the display name to apply to a project", + Description: "displayName is the display name to apply to a project", Type: []string{"string"}, Format: "", }, }, "description": { SchemaProps: spec.SchemaProps{ - Description: "Description is the description to apply to a project", + Description: "description is the description to apply to a project", Type: []string{"string"}, Format: "", }, @@ -59348,7 +59357,7 @@ func schema_openshift_api_project_v1_ProjectSpec(ref common.ReferenceCallback) c Properties: map[string]spec.Schema{ "finalizers": { SchemaProps: spec.SchemaProps{ - Description: "Finalizers is an opaque list of values that must be empty to permanently remove object from storage", + Description: "finalizers is an opaque list of values that must be empty to permanently remove object from storage", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -59376,7 +59385,7 @@ func schema_openshift_api_project_v1_ProjectStatus(ref common.ReferenceCallback) Properties: map[string]spec.Schema{ "phase": { SchemaProps: spec.SchemaProps{ - 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", + 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", Type: []string{"string"}, Format: "", Enum: []interface{}{"Active", "Terminating"}, @@ -59440,14 +59449,14 @@ func schema_openshift_api_quota_v1_AppliedClusterResourceQuota(ref common.Refere }, "spec": { SchemaProps: spec.SchemaProps{ - Description: "Spec defines the desired quota", + Description: "spec defines the desired quota", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/quota/v1.ClusterResourceQuotaSpec"), }, }, "status": { SchemaProps: spec.SchemaProps{ - Description: "Status defines the actual enforced quota and its current usage", + Description: "status defines the actual enforced quota and its current usage", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/quota/v1.ClusterResourceQuotaStatus"), }, @@ -59491,7 +59500,7 @@ func schema_openshift_api_quota_v1_AppliedClusterResourceQuotaList(ref common.Re }, "items": { SchemaProps: spec.SchemaProps{ - Description: "Items is a list of AppliedClusterResourceQuota", + Description: "items is a list of AppliedClusterResourceQuota", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -59542,14 +59551,14 @@ func schema_openshift_api_quota_v1_ClusterResourceQuota(ref common.ReferenceCall }, "spec": { SchemaProps: spec.SchemaProps{ - Description: "Spec defines the desired quota", + Description: "spec defines the desired quota", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/quota/v1.ClusterResourceQuotaSpec"), }, }, "status": { SchemaProps: spec.SchemaProps{ - Description: "Status defines the actual enforced quota and its current usage", + Description: "status defines the actual enforced quota and its current usage", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/quota/v1.ClusterResourceQuotaStatus"), }, @@ -59593,7 +59602,7 @@ func schema_openshift_api_quota_v1_ClusterResourceQuotaList(ref common.Reference }, "items": { SchemaProps: spec.SchemaProps{ - Description: "Items is a list of ClusterResourceQuotas", + Description: "items is a list of ClusterResourceQuotas", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -59660,14 +59669,14 @@ func schema_openshift_api_quota_v1_ClusterResourceQuotaSpec(ref common.Reference Properties: map[string]spec.Schema{ "selector": { SchemaProps: spec.SchemaProps{ - 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.", + 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: map[string]interface{}{}, Ref: ref("github.com/openshift/api/quota/v1.ClusterResourceQuotaSelector"), }, }, "quota": { SchemaProps: spec.SchemaProps{ - Description: "Quota defines the desired quota", + Description: "quota defines the desired quota", Default: map[string]interface{}{}, Ref: ref("k8s.io/api/core/v1.ResourceQuotaSpec"), }, @@ -59690,14 +59699,14 @@ func schema_openshift_api_quota_v1_ClusterResourceQuotaStatus(ref common.Referen Properties: map[string]spec.Schema{ "total": { SchemaProps: spec.SchemaProps{ - Description: "Total defines the actual enforced quota and its current usage across all projects", + Description: "total defines the actual enforced quota and its current usage across all projects", Default: map[string]interface{}{}, Ref: ref("k8s.io/api/core/v1.ResourceQuotaStatus"), }, }, "namespaces": { SchemaProps: spec.SchemaProps{ - 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.", + 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.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -59727,7 +59736,7 @@ func schema_openshift_api_quota_v1_ResourceQuotaStatusByNamespace(ref common.Ref Properties: map[string]spec.Schema{ "namespace": { SchemaProps: spec.SchemaProps{ - Description: "Namespace the project this status applies to", + Description: "namespace the project this status applies to", Default: "", Type: []string{"string"}, Format: "", @@ -59735,7 +59744,7 @@ func schema_openshift_api_quota_v1_ResourceQuotaStatusByNamespace(ref common.Ref }, "status": { SchemaProps: spec.SchemaProps{ - Description: "Status indicates how many resources have been consumed by this project", + Description: "status indicates how many resources have been consumed by this project", Default: map[string]interface{}{}, Ref: ref("k8s.io/api/core/v1.ResourceQuotaStatus"), }, @@ -59988,7 +59997,7 @@ func schema_openshift_api_route_v1_RouteIngress(ref common.ReferenceCallback) co Properties: map[string]spec.Schema{ "host": { SchemaProps: spec.SchemaProps{ - Description: "Host is the host string under which the route is exposed; this value is required", + Description: "host is the host string under which the route is exposed; this value is required", Type: []string{"string"}, Format: "", }, @@ -60010,7 +60019,7 @@ func schema_openshift_api_route_v1_RouteIngress(ref common.ReferenceCallback) co }, }, SchemaProps: spec.SchemaProps{ - Description: "Conditions is the state of the route, may be empty.", + Description: "conditions is the state of the route, may be empty.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -60053,7 +60062,7 @@ func schema_openshift_api_route_v1_RouteIngressCondition(ref common.ReferenceCal Properties: map[string]spec.Schema{ "type": { SchemaProps: spec.SchemaProps{ - Description: "Type is the type of the condition. Currently only Admitted or UnservableInFutureVersions.", + Description: "type is the type of the condition. Currently only Admitted or UnservableInFutureVersions.", Default: "", Type: []string{"string"}, Format: "", @@ -60061,7 +60070,7 @@ func schema_openshift_api_route_v1_RouteIngressCondition(ref common.ReferenceCal }, "status": { SchemaProps: spec.SchemaProps{ - Description: "Status is the status of the condition. Can be True, False, Unknown.", + Description: "status is the status of the condition. Can be True, False, Unknown.", Default: "", Type: []string{"string"}, Format: "", @@ -60844,7 +60853,7 @@ func schema_openshift_api_security_v1_AllowedFlexVolume(ref common.ReferenceCall Properties: map[string]spec.Schema{ "driver": { SchemaProps: spec.SchemaProps{ - Description: "Driver is the name of the Flexvolume driver.", + Description: "driver is the name of the Flexvolume driver.", Default: "", Type: []string{"string"}, Format: "", @@ -60866,7 +60875,7 @@ func schema_openshift_api_security_v1_FSGroupStrategyOptions(ref common.Referenc Properties: map[string]spec.Schema{ "type": { SchemaProps: spec.SchemaProps{ - Description: "Type is the strategy that will dictate what FSGroup is used in the SecurityContext.", + Description: "type is the strategy that will dictate what FSGroup is used in the SecurityContext.", Type: []string{"string"}, Format: "", }, @@ -60878,7 +60887,7 @@ func schema_openshift_api_security_v1_FSGroupStrategyOptions(ref common.Referenc }, }, SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -60907,14 +60916,14 @@ func schema_openshift_api_security_v1_IDRange(ref common.ReferenceCallback) comm Properties: map[string]spec.Schema{ "min": { SchemaProps: spec.SchemaProps{ - Description: "Min is the start of the range, inclusive.", + Description: "min is the start of the range, inclusive.", Type: []string{"integer"}, Format: "int64", }, }, "max": { SchemaProps: spec.SchemaProps{ - Description: "Max is the end of the range, inclusive.", + Description: "max is the end of the range, inclusive.", Type: []string{"integer"}, Format: "int64", }, @@ -61361,28 +61370,28 @@ func schema_openshift_api_security_v1_RunAsUserStrategyOptions(ref common.Refere Properties: map[string]spec.Schema{ "type": { SchemaProps: spec.SchemaProps{ - Description: "Type is the strategy that will dictate what RunAsUser is used in the SecurityContext.", + Description: "type is the strategy that will dictate what RunAsUser is used in the SecurityContext.", Type: []string{"string"}, Format: "", }, }, "uid": { SchemaProps: spec.SchemaProps{ - Description: "UID is the user id that containers must run as. Required for the MustRunAs strategy if not using namespace/service account allocated uids.", + 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: []string{"integer"}, Format: "int64", }, }, "uidRangeMin": { SchemaProps: spec.SchemaProps{ - Description: "UIDRangeMin defines the min value for a strategy that allocates by range.", + Description: "uidRangeMin defines the min value for a strategy that allocates by range.", Type: []string{"integer"}, Format: "int64", }, }, "uidRangeMax": { SchemaProps: spec.SchemaProps{ - Description: "UIDRangeMax defines the max value for a strategy that allocates by range.", + Description: "uidRangeMax defines the max value for a strategy that allocates by range.", Type: []string{"integer"}, Format: "int64", }, @@ -61402,7 +61411,7 @@ func schema_openshift_api_security_v1_SELinuxContextStrategyOptions(ref common.R Properties: map[string]spec.Schema{ "type": { SchemaProps: spec.SchemaProps{ - Description: "Type is the strategy that will dictate what SELinux context is used in the SecurityContext.", + Description: "type is the strategy that will dictate what SELinux context is used in the SecurityContext.", Type: []string{"string"}, Format: "", }, @@ -61451,14 +61460,14 @@ func schema_openshift_api_security_v1_SecurityContextConstraints(ref common.Refe }, "priority": { SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"integer"}, Format: "int32", }, }, "allowPrivilegedContainer": { SchemaProps: spec.SchemaProps{ - Description: "AllowPrivilegedContainer determines if a container can request to be run as privileged.", + Description: "allowPrivilegedContainer determines if a container can request to be run as privileged.", Default: false, Type: []string{"boolean"}, Format: "", @@ -61471,7 +61480,7 @@ func schema_openshift_api_security_v1_SecurityContextConstraints(ref common.Refe }, }, SchemaProps: spec.SchemaProps{ - 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.", + 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.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -61491,7 +61500,7 @@ func schema_openshift_api_security_v1_SecurityContextConstraints(ref common.Refe }, }, SchemaProps: spec.SchemaProps{ - Description: "RequiredDropCapabilities are the capabilities that will be dropped from the container. These are required to be dropped and cannot be added.", + Description: "requiredDropCapabilities are the capabilities that will be dropped from the container. These are required to be dropped and cannot be added.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -61511,7 +61520,7 @@ func schema_openshift_api_security_v1_SecurityContextConstraints(ref common.Refe }, }, SchemaProps: spec.SchemaProps{ - 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 '*'.", + 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 '*'.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -61526,7 +61535,7 @@ func schema_openshift_api_security_v1_SecurityContextConstraints(ref common.Refe }, "allowHostDirVolumePlugin": { SchemaProps: spec.SchemaProps{ - Description: "AllowHostDirVolumePlugin determines if the policy allow containers to use the HostDir volume plugin", + Description: "allowHostDirVolumePlugin determines if the policy allow containers to use the HostDir volume plugin", Default: false, Type: []string{"boolean"}, Format: "", @@ -61539,7 +61548,7 @@ func schema_openshift_api_security_v1_SecurityContextConstraints(ref common.Refe }, }, SchemaProps: spec.SchemaProps{ - 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\"].", + 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\"].", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -61559,7 +61568,7 @@ func schema_openshift_api_security_v1_SecurityContextConstraints(ref common.Refe }, }, SchemaProps: spec.SchemaProps{ - 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.", + 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.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -61573,7 +61582,7 @@ func schema_openshift_api_security_v1_SecurityContextConstraints(ref common.Refe }, "allowHostNetwork": { SchemaProps: spec.SchemaProps{ - Description: "AllowHostNetwork determines if the policy allows the use of HostNetwork in the pod spec.", + Description: "allowHostNetwork determines if the policy allows the use of HostNetwork in the pod spec.", Default: false, Type: []string{"boolean"}, Format: "", @@ -61581,7 +61590,7 @@ func schema_openshift_api_security_v1_SecurityContextConstraints(ref common.Refe }, "allowHostPorts": { SchemaProps: spec.SchemaProps{ - Description: "AllowHostPorts determines if the policy allows host ports in the containers.", + Description: "allowHostPorts determines if the policy allows host ports in the containers.", Default: false, Type: []string{"boolean"}, Format: "", @@ -61589,7 +61598,7 @@ func schema_openshift_api_security_v1_SecurityContextConstraints(ref common.Refe }, "allowHostPID": { SchemaProps: spec.SchemaProps{ - Description: "AllowHostPID determines if the policy allows host pid in the containers.", + Description: "allowHostPID determines if the policy allows host pid in the containers.", Default: false, Type: []string{"boolean"}, Format: "", @@ -61597,7 +61606,7 @@ func schema_openshift_api_security_v1_SecurityContextConstraints(ref common.Refe }, "allowHostIPC": { SchemaProps: spec.SchemaProps{ - Description: "AllowHostIPC determines if the policy allows host ipc in the containers.", + Description: "allowHostIPC determines if the policy allows host ipc in the containers.", Default: false, Type: []string{"boolean"}, Format: "", @@ -61613,49 +61622,49 @@ func schema_openshift_api_security_v1_SecurityContextConstraints(ref common.Refe }, "defaultAllowPrivilegeEscalation": { SchemaProps: spec.SchemaProps{ - Description: "DefaultAllowPrivilegeEscalation controls the default setting for whether a process can gain more privileges than its parent process.", + Description: "defaultAllowPrivilegeEscalation controls the default setting for whether a process can gain more privileges than its parent process.", Type: []string{"boolean"}, Format: "", }, }, "allowPrivilegeEscalation": { SchemaProps: spec.SchemaProps{ - Description: "AllowPrivilegeEscalation determines if a pod can request to allow privilege escalation. If unspecified, defaults to true.", + Description: "allowPrivilegeEscalation determines if a pod can request to allow privilege escalation. If unspecified, defaults to true.", Type: []string{"boolean"}, Format: "", }, }, "seLinuxContext": { SchemaProps: spec.SchemaProps{ - Description: "SELinuxContext is the strategy that will dictate what labels will be set in the SecurityContext.", + Description: "seLinuxContext is the strategy that will dictate what labels will be set in the SecurityContext.", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/security/v1.SELinuxContextStrategyOptions"), }, }, "runAsUser": { SchemaProps: spec.SchemaProps{ - Description: "RunAsUser is the strategy that will dictate what RunAsUser is used in the SecurityContext.", + Description: "runAsUser is the strategy that will dictate what RunAsUser is used in the SecurityContext.", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/security/v1.RunAsUserStrategyOptions"), }, }, "supplementalGroups": { SchemaProps: spec.SchemaProps{ - Description: "SupplementalGroups is the strategy that will dictate what supplemental groups are used by the SecurityContext.", + Description: "supplementalGroups is the strategy that will dictate what supplemental groups are used by the SecurityContext.", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/security/v1.SupplementalGroupsStrategyOptions"), }, }, "fsGroup": { SchemaProps: spec.SchemaProps{ - Description: "FSGroup is the strategy that will dictate what fs group is used by the SecurityContext.", + Description: "fsGroup is the strategy that will dictate what fs group is used by the SecurityContext.", Default: map[string]interface{}{}, Ref: ref("github.com/openshift/api/security/v1.FSGroupStrategyOptions"), }, }, "readOnlyRootFilesystem": { SchemaProps: spec.SchemaProps{ - 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.", + 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.", Default: false, Type: []string{"boolean"}, Format: "", @@ -61708,7 +61717,7 @@ func schema_openshift_api_security_v1_SecurityContextConstraints(ref common.Refe }, }, SchemaProps: spec.SchemaProps{ - 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.", + 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.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -61728,7 +61737,7 @@ func schema_openshift_api_security_v1_SecurityContextConstraints(ref common.Refe }, }, SchemaProps: spec.SchemaProps{ - 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.", + 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.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -61748,7 +61757,7 @@ func schema_openshift_api_security_v1_SecurityContextConstraints(ref common.Refe }, }, SchemaProps: spec.SchemaProps{ - 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.", + 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.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -61874,7 +61883,7 @@ func schema_openshift_api_security_v1_SupplementalGroupsStrategyOptions(ref comm Properties: map[string]spec.Schema{ "type": { SchemaProps: spec.SchemaProps{ - Description: "Type is the strategy that will dictate what supplemental groups is used in the SecurityContext.", + Description: "type is the strategy that will dictate what supplemental groups is used in the SecurityContext.", Type: []string{"string"}, Format: "", }, @@ -61886,7 +61895,7 @@ func schema_openshift_api_security_v1_SupplementalGroupsStrategyOptions(ref comm }, }, SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -62088,7 +62097,7 @@ func schema_openshift_api_servicecertsigner_v1alpha1_ServiceCertSignerOperatorCo }, "items": { SchemaProps: spec.SchemaProps{ - Description: "Items contains the items", + Description: "items contains the items", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -62253,7 +62262,7 @@ func schema_openshift_api_sharedresource_v1alpha1_SharedConfigMap(ref common.Ref return common.OpenAPIDefinition{ Schema: spec.Schema{ SchemaProps: spec.SchemaProps{ - 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 volumes:\n - name: shared-configmap\n csi:\n driver: csi.sharedresource.openshift.io\n volumeAttributes:\n 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 `oc create role shared-resource-my-share --verb=use --resource=sharedconfigmaps.sharedresource.openshift.io --resource-name=my-share`\n `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.", + 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.", Type: []string{"object"}, Properties: map[string]spec.Schema{ "kind": { @@ -62292,6 +62301,7 @@ func schema_openshift_api_sharedresource_v1alpha1_SharedConfigMap(ref common.Ref }, }, }, + Required: []string{"spec"}, }, }, Dependencies: []string{ @@ -62448,7 +62458,7 @@ func schema_openshift_api_sharedresource_v1alpha1_SharedSecret(ref common.Refere return common.OpenAPIDefinition{ Schema: spec.Schema{ SchemaProps: spec.SchemaProps{ - 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 volumes:\n - name: shared-secret\n csi:\n driver: csi.sharedresource.openshift.io\n volumeAttributes:\n 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 `oc create role shared-resource-my-share --verb=use --resource=sharedsecrets.sharedresource.openshift.io --resource-name=my-share`\n `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.", + 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.", Type: []string{"object"}, Properties: map[string]spec.Schema{ "kind": { @@ -62487,6 +62497,7 @@ func schema_openshift_api_sharedresource_v1alpha1_SharedSecret(ref common.Refere }, }, }, + Required: []string{"spec"}, }, }, Dependencies: []string{ @@ -62743,7 +62754,7 @@ func schema_openshift_api_template_v1_BrokerTemplateInstanceSpec(ref common.Refe Properties: map[string]spec.Schema{ "templateInstance": { SchemaProps: spec.SchemaProps{ - Description: "templateinstance is a reference to a TemplateInstance object residing in a namespace.", + Description: "templateInstance is a reference to a TemplateInstance object residing in a namespace.", Default: map[string]interface{}{}, Ref: ref("k8s.io/api/core/v1.ObjectReference"), }, @@ -62757,7 +62768,7 @@ func schema_openshift_api_template_v1_BrokerTemplateInstanceSpec(ref common.Refe }, "bindingIDs": { SchemaProps: spec.SchemaProps{ - Description: "bindingids is a list of 'binding_id's provided during successive bind calls to the template service broker.", + Description: "bindingIDs is a list of 'binding_id's provided during successive bind calls to the template service broker.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -62788,7 +62799,7 @@ func schema_openshift_api_template_v1_Parameter(ref common.ReferenceCallback) co Properties: map[string]spec.Schema{ "name": { SchemaProps: spec.SchemaProps{ - Description: "Name must be set and it can be referenced in Template Items using ${PARAMETER_NAME}. Required.", + Description: "name must be set and it can be referenced in Template Items using ${PARAMETER_NAME}. Required.", Default: "", Type: []string{"string"}, Format: "", @@ -62803,14 +62814,14 @@ func schema_openshift_api_template_v1_Parameter(ref common.ReferenceCallback) co }, "description": { SchemaProps: spec.SchemaProps{ - Description: "Description of a parameter. Optional.", + Description: "description of a parameter. Optional.", Type: []string{"string"}, Format: "", }, }, "value": { SchemaProps: spec.SchemaProps{ - 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.", + 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{"string"}, Format: "", }, @@ -62824,7 +62835,7 @@ func schema_openshift_api_template_v1_Parameter(ref common.ReferenceCallback) co }, "from": { SchemaProps: spec.SchemaProps{ - Description: "From is an input value for the generator. Optional.", + Description: "from is an input value for the generator. Optional.", Type: []string{"string"}, Format: "", }, @@ -62990,7 +63001,7 @@ func schema_openshift_api_template_v1_TemplateInstanceCondition(ref common.Refer Properties: map[string]spec.Schema{ "type": { SchemaProps: spec.SchemaProps{ - Description: "Type of the condition, currently Ready or InstantiateFailure.", + Description: "type of the condition, currently Ready or InstantiateFailure.", Default: "", Type: []string{"string"}, Format: "", @@ -62998,7 +63009,7 @@ func schema_openshift_api_template_v1_TemplateInstanceCondition(ref common.Refer }, "status": { SchemaProps: spec.SchemaProps{ - Description: "Status of the condition, one of True, False or Unknown.", + Description: "status of the condition, one of True, False or Unknown.", Default: "", Type: []string{"string"}, Format: "", @@ -63006,13 +63017,13 @@ func schema_openshift_api_template_v1_TemplateInstanceCondition(ref common.Refer }, "lastTransitionTime": { SchemaProps: spec.SchemaProps{ - Description: "LastTransitionTime is the last time a condition status transitioned from one state to another.", + Description: "lastTransitionTime is the last time a condition status transitioned from one state to another.", Ref: ref("k8s.io/apimachinery/pkg/apis/meta/v1.Time"), }, }, "reason": { SchemaProps: spec.SchemaProps{ - Description: "Reason is a brief machine readable explanation for the condition's last transition.", + Description: "reason is a brief machine readable explanation for the condition's last transition.", Default: "", Type: []string{"string"}, Format: "", @@ -63020,7 +63031,7 @@ func schema_openshift_api_template_v1_TemplateInstanceCondition(ref common.Refer }, "message": { SchemaProps: spec.SchemaProps{ - Description: "Message is a human readable description of the details of the last transition, complementing reason.", + Description: "message is a human readable description of the details of the last transition, complementing reason.", Default: "", Type: []string{"string"}, Format: "", @@ -63231,7 +63242,7 @@ func schema_openshift_api_template_v1_TemplateInstanceStatus(ref common.Referenc }, "objects": { SchemaProps: spec.SchemaProps{ - Description: "Objects references the objects created by the TemplateInstance.", + Description: "objects references the objects created by the TemplateInstance.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -63281,7 +63292,7 @@ func schema_openshift_api_template_v1_TemplateList(ref common.ReferenceCallback) }, "items": { SchemaProps: spec.SchemaProps{ - Description: "Items is a list of templates", + Description: "items is a list of templates", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -63332,7 +63343,7 @@ func schema_openshift_api_user_v1_Group(ref common.ReferenceCallback) common.Ope }, "users": { SchemaProps: spec.SchemaProps{ - Description: "Users is the list of users in this group.", + Description: "users is the list of users in this group.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -63384,7 +63395,7 @@ func schema_openshift_api_user_v1_GroupList(ref common.ReferenceCallback) common }, "items": { SchemaProps: spec.SchemaProps{ - Description: "Items is the list of groups", + Description: "items is the list of groups", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -63435,7 +63446,7 @@ func schema_openshift_api_user_v1_Identity(ref common.ReferenceCallback) common. }, "providerName": { SchemaProps: spec.SchemaProps{ - Description: "ProviderName is the source of identity information", + Description: "providerName is the source of identity information", Default: "", Type: []string{"string"}, Format: "", @@ -63443,7 +63454,7 @@ func schema_openshift_api_user_v1_Identity(ref common.ReferenceCallback) common. }, "providerUserName": { SchemaProps: spec.SchemaProps{ - Description: "ProviderUserName uniquely represents this identity in the scope of the provider", + Description: "providerUserName uniquely represents this identity in the scope of the provider", Default: "", Type: []string{"string"}, Format: "", @@ -63451,14 +63462,14 @@ func schema_openshift_api_user_v1_Identity(ref common.ReferenceCallback) common. }, "user": { SchemaProps: spec.SchemaProps{ - Description: "User is a reference to the user this identity is associated with Both Name and UID must be set", + Description: "user is a reference to the user this identity is associated with Both Name and UID must be set", Default: map[string]interface{}{}, Ref: ref("k8s.io/api/core/v1.ObjectReference"), }, }, "extra": { SchemaProps: spec.SchemaProps{ - Description: "Extra holds extra information about this identity", + Description: "extra holds extra information about this identity", Type: []string{"object"}, AdditionalProperties: &spec.SchemaOrBool{ Allows: true, @@ -63511,7 +63522,7 @@ func schema_openshift_api_user_v1_IdentityList(ref common.ReferenceCallback) com }, "items": { SchemaProps: spec.SchemaProps{ - Description: "Items is the list of identities", + Description: "items is the list of identities", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -63562,14 +63573,14 @@ func schema_openshift_api_user_v1_User(ref common.ReferenceCallback) common.Open }, "fullName": { SchemaProps: spec.SchemaProps{ - Description: "FullName is the full name of user", + Description: "fullName is the full name of user", Type: []string{"string"}, Format: "", }, }, "identities": { SchemaProps: spec.SchemaProps{ - Description: "Identities are the identities associated with this user", + Description: "identities are the identities associated with this user", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -63584,7 +63595,7 @@ func schema_openshift_api_user_v1_User(ref common.ReferenceCallback) common.Open }, "groups": { SchemaProps: spec.SchemaProps{ - 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.", + 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: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -63636,14 +63647,14 @@ func schema_openshift_api_user_v1_UserIdentityMapping(ref common.ReferenceCallba }, "identity": { SchemaProps: spec.SchemaProps{ - Description: "Identity is a reference to an identity", + Description: "identity is a reference to an identity", Default: map[string]interface{}{}, Ref: ref("k8s.io/api/core/v1.ObjectReference"), }, }, "user": { SchemaProps: spec.SchemaProps{ - Description: "User is a reference to a user", + Description: "user is a reference to a user", Default: map[string]interface{}{}, Ref: ref("k8s.io/api/core/v1.ObjectReference"), }, @@ -63686,7 +63697,7 @@ func schema_openshift_api_user_v1_UserList(ref common.ReferenceCallback) common. }, "items": { SchemaProps: spec.SchemaProps{ - Description: "Items is the list of users", + Description: "items is the list of users", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ diff --git a/openapi/openapi.json b/openapi/openapi.json index f43d3613467..5e18ad4ae9d 100644 --- a/openapi/openapi.json +++ b/openapi/openapi.json @@ -204,7 +204,7 @@ "default": "" }, "username": { - "description": "userName that made the request.", + "description": "username that made the request.", "type": "string", "default": "" } @@ -236,7 +236,7 @@ "type": "object", "properties": { "command": { - "description": "Command is optional and overrides CMD in the container Image.", + "description": "command is optional and overrides CMD in the container Image.", "type": "array", "items": { "type": "string", @@ -244,7 +244,7 @@ } }, "environment": { - "description": "Environment holds the environment which will be given to the container for Image.", + "description": "environment holds the environment which will be given to the container for Image.", "type": "array", "items": { "default": {}, @@ -252,7 +252,7 @@ } }, "image": { - "description": "Image specifies a container image which can carry out a deployment.", + "description": "image specifies a container image which can carry out a deployment.", "type": "string" } } @@ -265,11 +265,11 @@ ], "properties": { "imageTrigger": { - "description": "ImageTrigger contains the image trigger details, if this trigger was fired based on an image change", + "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" }, "type": { - "description": "Type of the trigger that resulted in the creation of a new deployment", + "description": "type of the trigger that resulted in the creation of a new deployment", "type": "string", "default": "" } @@ -283,7 +283,7 @@ ], "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.", + "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" } @@ -314,12 +314,12 @@ "type": "string" }, "status": { - "description": "Status of the condition, one of True, False, Unknown.", + "description": "status of the condition, one of True, False, Unknown.", "type": "string", "default": "" }, "type": { - "description": "Type of deployment condition.", + "description": "type of deployment condition.", "type": "string", "default": "" } @@ -346,12 +346,12 @@ "$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 represents a desired deployment state and how to deploy to it.", "default": {}, "$ref": "#/definitions/com.github.openshift.api.apps.v1.DeploymentConfigSpec" }, "status": { - "description": "Status represents the current deployment state.", + "description": "status represents the current deployment state.", "default": {}, "$ref": "#/definitions/com.github.openshift.api.apps.v1.DeploymentConfigStatus" } @@ -369,7 +369,7 @@ "type": "string" }, "items": { - "description": "Items is a list of deployment configs", + "description": "items is a list of deployment configs", "type": "array", "items": { "default": {}, @@ -404,17 +404,17 @@ "type": "string" }, "name": { - "description": "Name of the deployment config that will be rolled back.", + "description": "name of the deployment config that will be rolled back.", "type": "string", "default": "" }, "spec": { - "description": "Spec defines the options to rollback generation.", + "description": "spec defines the options to rollback generation.", "default": {}, "$ref": "#/definitions/com.github.openshift.api.apps.v1.DeploymentConfigRollbackSpec" }, "updatedAnnotations": { - "description": "UpdatedAnnotations is a set of new annotations that will be added in the deployment config.", + "description": "updatedAnnotations is a set of new annotations that will be added in the deployment config.", "type": "object", "additionalProperties": { "type": "string", @@ -435,32 +435,32 @@ ], "properties": { "from": { - "description": "From points to a ReplicationController which is a deployment.", + "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.", + "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.", + "description": "includeStrategy specifies whether to include the deployment Strategy.", "type": "boolean", "default": false }, "includeTemplate": { - "description": "IncludeTemplate specifies whether to include the PodTemplateSpec.", + "description": "includeTemplate specifies whether to include the PodTemplateSpec.", "type": "boolean", "default": false }, "includeTriggers": { - "description": "IncludeTriggers specifies whether to include config Triggers.", + "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.", + "description": "revision to rollback to. If set to 0, rollback to the last revision.", "type": "integer", "format": "int64" } @@ -471,27 +471,27 @@ "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)", + "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.", + "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.", + "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.)", + "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.", + "description": "selector is a label query over pods that should match the Replicas count.", "type": "object", "additionalProperties": { "type": "string", @@ -499,21 +499,21 @@ } }, "strategy": { - "description": "Strategy describes how a deployment is executed.", + "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.", + "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.", + "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.", + "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": {}, @@ -535,13 +535,13 @@ ], "properties": { "availableReplicas": { - "description": "AvailableReplicas is the total number of available pods targeted by this deployment config.", + "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.", + "description": "conditions represents the latest available observations of a deployment config's current state.", "type": "array", "items": { "default": {}, @@ -551,17 +551,17 @@ "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", + "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.", + "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.", + "description": "observedGeneration is the most recent generation observed by the deployment config controller.", "type": "integer", "format": "int64", "default": 0 @@ -572,19 +572,19 @@ "format": "int32" }, "replicas": { - "description": "Replicas is the total number of pods targeted by this deployment config.", + "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.", + "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.", + "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 @@ -599,7 +599,7 @@ ], "properties": { "causes": { - "description": "Causes are extended data associated with all the causes for creating a new deployment", + "description": "causes are extended data associated with all the causes for creating a new deployment", "type": "array", "items": { "default": {}, @@ -607,7 +607,7 @@ } }, "message": { - "description": "Message is the user specified change message, if this deployment was triggered manually by the user", + "description": "message is the user specified change message, if this deployment was triggered manually by the user", "type": "string" } } @@ -639,7 +639,7 @@ "type": "string" }, "follow": { - "description": "Follow if true indicates that the build log should be streamed until the build terminates.", + "description": "follow if true indicates that the build log should be streamed until the build terminates.", "type": "boolean" }, "kind": { @@ -652,7 +652,7 @@ "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.", + "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": { @@ -678,7 +678,7 @@ "type": "boolean" }, "version": { - "description": "Version of the deployment for which to view logs.", + "description": "version of the deployment for which to view logs.", "type": "integer", "format": "int64" } @@ -698,7 +698,7 @@ "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.", + "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", @@ -706,7 +706,7 @@ } }, "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.", + "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 }, @@ -715,12 +715,12 @@ "type": "string" }, "latest": { - "description": "Latest will update the deployment config with the latest state from all triggers.", + "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.", + "description": "name of the deployment config for requesting a new deployment.", "type": "string", "default": "" } @@ -731,12 +731,12 @@ "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.", + "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.", + "description": "annotations is a set of key, value pairs added to custom deployer and lifecycle pre/post hook pods.", "type": "object", "additionalProperties": { "type": "string", @@ -744,11 +744,11 @@ } }, "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.", + "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.", + "description": "labels is a set of key, value pairs added to custom deployer and lifecycle pre/post hook pods.", "type": "object", "additionalProperties": { "type": "string", @@ -756,20 +756,20 @@ } }, "recreateParams": { - "description": "RecreateParams are the input to the Recreate deployment strategy.", + "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.", + "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.", + "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.", + "description": "type is the name of a deployment strategy.", "type": "string" } } @@ -782,11 +782,11 @@ ], "properties": { "automatic": { - "description": "Automatic means that the detection of a new tag value should result in an image update inside the pod template.", + "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.", + "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", @@ -794,12 +794,12 @@ } }, "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.", + "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.", + "description": "lastTriggeredImage is the last image to be triggered.", "type": "string" } } @@ -809,11 +809,11 @@ "type": "object", "properties": { "imageChangeParams": { - "description": "ImageChangeParams represents the parameters for the ImageChange trigger.", + "description": "imageChangeParams represents the parameters for the ImageChange trigger.", "$ref": "#/definitions/com.github.openshift.api.apps.v1.DeploymentTriggerImageChangeParams" }, "type": { - "description": "Type of the trigger", + "description": "type of the trigger", "type": "string" } } @@ -827,7 +827,7 @@ ], "properties": { "command": { - "description": "Command is the action command and its arguments.", + "description": "command is the action command and its arguments.", "type": "array", "items": { "type": "string", @@ -835,12 +835,12 @@ } }, "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.", + "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.", + "description": "env is a set of environment variables to supply to the hook pod's container.", "type": "array", "items": { "default": {}, @@ -848,7 +848,7 @@ } }, "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.", + "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", @@ -865,16 +865,16 @@ ], "properties": { "execNewPod": { - "description": "ExecNewPod specifies the options for a lifecycle hook backed by a pod.", + "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.", + "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.", + "description": "tagImages instructs the deployer to tag the current image referenced under a container onto an image stream tag.", "type": "array", "items": { "default": {}, @@ -888,19 +888,19 @@ "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.", + "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.", + "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.", + "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.", + "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" } @@ -911,33 +911,33 @@ "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.", + "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.", + "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.", + "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.", + "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.", + "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.", + "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.", + "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" } @@ -952,12 +952,12 @@ ], "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.", + "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.", + "description": "to is the target ImageStreamTag to set the container's image onto.", "default": {}, "$ref": "#/definitions/io.k8s.api.core.v1.ObjectReference" } @@ -978,26 +978,26 @@ ], "properties": { "content": { - "description": "Content is the actual content of the request for create and update", + "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)", + "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", + "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", + "description": "path is the path of a non resource URL", "type": "string", "default": "" }, "resource": { - "description": "Resource is one of the existing resource types", + "description": "resource is one of the existing resource types", "type": "string", "default": "" }, @@ -1012,12 +1012,12 @@ "default": "" }, "resourceName": { - "description": "ResourceName is the name of the resource being requested for a \"get\" or deleted for a \"delete\"", + "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", + "description": "verb is one of: get, list, watch, create, update, delete", "type": "string", "default": "" } @@ -1031,7 +1031,7 @@ ], "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.", + "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": { @@ -1048,7 +1048,7 @@ "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta" }, "rules": { - "description": "Rules holds all the PolicyRules for this ClusterRole", + "description": "rules holds all the PolicyRules for this ClusterRole", "type": "array", "items": { "default": {}, @@ -1070,7 +1070,7 @@ "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.", + "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", @@ -1087,12 +1087,12 @@ "$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.", + "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.", + "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": {}, @@ -1100,7 +1100,7 @@ } }, "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.", + "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", @@ -1121,7 +1121,7 @@ "type": "string" }, "items": { - "description": "Items is a list of ClusterRoleBindings", + "description": "items is a list of ClusterRoleBindings", "type": "array", "items": { "default": {}, @@ -1151,7 +1151,7 @@ "type": "string" }, "items": { - "description": "Items is a list of ClusterRoles", + "description": "items is a list of ClusterRoles", "type": "array", "items": { "default": {}, @@ -1178,7 +1178,7 @@ ], "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.", + "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", @@ -1228,11 +1228,11 @@ "type": "string" }, "content": { - "description": "Content is the actual content of the request for create and update", + "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)", + "description": "isNonResourceURL is true if this is a request for a non-resource URL (outside of the resource hierarchy)", "type": "boolean", "default": false }, @@ -1246,17 +1246,17 @@ "$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", + "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", + "description": "path is the path of a non resource URL", "type": "string", "default": "" }, "resource": { - "description": "Resource is one of the existing resource types", + "description": "resource is one of the existing resource types", "type": "string", "default": "" }, @@ -1271,12 +1271,12 @@ "default": "" }, "resourceName": { - "description": "ResourceName is the name of the resource being requested for a \"get\" or deleted for a \"delete\"", + "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", + "description": "verb is one of: get, list, watch, create, update, delete", "type": "string", "default": "" } @@ -1304,11 +1304,11 @@ "type": "string" }, "content": { - "description": "Content is the actual content of the request for create and update", + "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.", + "description": "groups is optional. Groups is the list of groups to which the User belongs.", "type": "array", "items": { "type": "string", @@ -1316,7 +1316,7 @@ } }, "isNonResourceURL": { - "description": "IsNonResourceURL is true if this is a request for a non-resource URL (outside of the resource hierarchy)", + "description": "isNonResourceURL is true if this is a request for a non-resource URL (outside of the resource hierarchy)", "type": "boolean", "default": false }, @@ -1330,17 +1330,17 @@ "$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", + "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", + "description": "path is the path of a non resource URL", "type": "string", "default": "" }, "resource": { - "description": "Resource is one of the existing resource types", + "description": "resource is one of the existing resource types", "type": "string", "default": "" }, @@ -1355,12 +1355,12 @@ "default": "" }, "resourceName": { - "description": "ResourceName is the name of the resource being requested for a \"get\" or deleted for a \"delete\"", + "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.", + "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", @@ -1368,12 +1368,12 @@ } }, "user": { - "description": "User is optional. If both User and Groups are empty, the current authenticated user is used.", + "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", + "description": "verb is one of: get, list, watch, create, update, delete", "type": "string", "default": "" } @@ -1388,12 +1388,12 @@ ], "properties": { "name": { - "description": "Name is the name of the cluster role", + "description": "name is the name of the cluster role", "type": "string", "default": "" }, "role": { - "description": "Role is the cluster role being named", + "description": "role is the cluster role being named", "default": {}, "$ref": "#/definitions/com.github.openshift.api.authorization.v1.ClusterRole" } @@ -1408,12 +1408,12 @@ ], "properties": { "name": { - "description": "Name is the name of the cluster role binding", + "description": "name is the name of the cluster role binding", "type": "string", "default": "" }, "roleBinding": { - "description": "RoleBinding is the cluster role binding being named", + "description": "roleBinding is the cluster role binding being named", "default": {}, "$ref": "#/definitions/com.github.openshift.api.authorization.v1.ClusterRoleBinding" } @@ -1428,12 +1428,12 @@ ], "properties": { "name": { - "description": "Name is the name of the role", + "description": "name is the name of the role", "type": "string", "default": "" }, "role": { - "description": "Role is the role being named", + "description": "role is the role being named", "default": {}, "$ref": "#/definitions/com.github.openshift.api.authorization.v1.Role" } @@ -1448,12 +1448,12 @@ ], "properties": { "name": { - "description": "Name is the name of the role binding", + "description": "name is the name of the role binding", "type": "string", "default": "" }, "roleBinding": { - "description": "RoleBinding is the role binding being named", + "description": "roleBinding is the role binding being named", "default": {}, "$ref": "#/definitions/com.github.openshift.api.authorization.v1.RoleBinding" } @@ -1468,7 +1468,7 @@ ], "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", + "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", @@ -1476,7 +1476,7 @@ } }, "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.", + "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": { @@ -1488,7 +1488,7 @@ } }, "resourceNames": { - "description": "ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.", + "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", @@ -1496,7 +1496,7 @@ } }, "resources": { - "description": "Resources is a list of resources this rule applies to. ResourceAll represents all resources.", + "description": "resources is a list of resources this rule applies to. ResourceAll represents all resources.", "type": "array", "items": { "type": "string", @@ -1504,7 +1504,7 @@ } }, "verbs": { - "description": "Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. VerbAll represents all kinds.", + "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", @@ -1532,11 +1532,11 @@ "type": "string" }, "content": { - "description": "Content is the actual content of the request for create and update", + "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)", + "description": "isNonResourceURL is true if this is a request for a non-resource URL (outside of the resource hierarchy)", "type": "boolean", "default": false }, @@ -1550,17 +1550,17 @@ "$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", + "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", + "description": "path is the path of a non resource URL", "type": "string", "default": "" }, "resource": { - "description": "Resource is one of the existing resource types", + "description": "resource is one of the existing resource types", "type": "string", "default": "" }, @@ -1575,12 +1575,12 @@ "default": "" }, "resourceName": { - "description": "ResourceName is the name of the resource being requested for a \"get\" or deleted for a \"delete\"", + "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", + "description": "verb is one of: get, list, watch, create, update, delete", "type": "string", "default": "" } @@ -1617,7 +1617,7 @@ "type": "string" }, "namespace": { - "description": "Namespace is the namespace used for the access review", + "description": "namespace is the namespace used for the access review", "type": "string" }, "users": { @@ -1651,7 +1651,7 @@ "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta" }, "rules": { - "description": "Rules holds all the PolicyRules for this Role", + "description": "rules holds all the PolicyRules for this Role", "type": "array", "items": { "default": {}, @@ -1673,7 +1673,7 @@ "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.", + "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", @@ -1690,12 +1690,12 @@ "$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.", + "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.", + "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": {}, @@ -1703,7 +1703,7 @@ } }, "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.", + "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", @@ -1724,7 +1724,7 @@ "type": "string" }, "items": { - "description": "Items is a list of RoleBindings", + "description": "items is a list of RoleBindings", "type": "array", "items": { "default": {}, @@ -1764,7 +1764,7 @@ "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta" }, "spec": { - "description": "Spec defines the matcher.", + "description": "spec defines the matcher.", "default": {}, "$ref": "#/definitions/com.github.openshift.api.authorization.v1.RoleBindingRestrictionSpec" } @@ -1782,7 +1782,7 @@ "type": "string" }, "items": { - "description": "Items is a list of RoleBindingRestriction objects.", + "description": "items is a list of RoleBindingRestriction objects.", "type": "array", "items": { "default": {}, @@ -1810,15 +1810,15 @@ ], "properties": { "grouprestriction": { - "description": "GroupRestriction matches against group subjects.", + "description": "grouprestriction matches against group subjects.", "$ref": "#/definitions/com.github.openshift.api.authorization.v1.GroupRestriction" }, "serviceaccountrestriction": { - "description": "ServiceAccountRestriction matches against service-account subjects.", + "description": "serviceaccountrestriction matches against service-account subjects.", "$ref": "#/definitions/com.github.openshift.api.authorization.v1.ServiceAccountRestriction" }, "userrestriction": { - "description": "UserRestriction matches against user subjects.", + "description": "userrestriction matches against user subjects.", "$ref": "#/definitions/com.github.openshift.api.authorization.v1.UserRestriction" } } @@ -1835,7 +1835,7 @@ "type": "string" }, "items": { - "description": "Items is a list of Roles", + "description": "items is a list of Roles", "type": "array", "items": { "default": {}, @@ -1874,12 +1874,12 @@ "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta" }, "spec": { - "description": "Spec adds information about how to conduct the check", + "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", + "description": "status is completed by the server to tell which permissions you have", "default": {}, "$ref": "#/definitions/com.github.openshift.api.authorization.v1.SubjectRulesReviewStatus" } @@ -1893,7 +1893,7 @@ ], "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\".", + "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", @@ -1911,12 +1911,12 @@ ], "properties": { "name": { - "description": "Name is the name of the service account.", + "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.", + "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": "" } @@ -1931,7 +1931,7 @@ ], "properties": { "namespaces": { - "description": "Namespaces specifies a list of literal namespace names.", + "description": "namespaces specifies a list of literal namespace names.", "type": "array", "items": { "type": "string", @@ -1939,7 +1939,7 @@ } }, "serviceaccounts": { - "description": "ServiceAccounts specifies a list of literal service-account names.", + "description": "serviceaccounts specifies a list of literal service-account names.", "type": "array", "items": { "default": {}, @@ -1970,7 +1970,7 @@ "type": "string" }, "content": { - "description": "Content is the actual content of the request for create and update", + "description": "content is the actual content of the request for create and update", "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension" }, "groups": { @@ -1982,7 +1982,7 @@ } }, "isNonResourceURL": { - "description": "IsNonResourceURL is true if this is a request for a non-resource URL (outside of the resource hierarchy)", + "description": "isNonResourceURL is true if this is a request for a non-resource URL (outside of the resource hierarchy)", "type": "boolean", "default": false }, @@ -1996,17 +1996,17 @@ "$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", + "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", + "description": "path is the path of a non resource URL", "type": "string", "default": "" }, "resource": { - "description": "Resource is one of the existing resource types", + "description": "resource is one of the existing resource types", "type": "string", "default": "" }, @@ -2021,12 +2021,12 @@ "default": "" }, "resourceName": { - "description": "ResourceName is the name of the resource being requested for a \"get\" or deleted for a \"delete\"", + "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.", + "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", @@ -2034,12 +2034,12 @@ } }, "user": { - "description": "User is optional. If both User and Groups are empty, the current authenticated user is used.", + "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", + "description": "verb is one of: get, list, watch, create, update, delete", "type": "string", "default": "" } @@ -2053,7 +2053,7 @@ ], "properties": { "allowed": { - "description": "Allowed is required. True if the action would be allowed, false otherwise.", + "description": "allowed is required. True if the action would be allowed, false otherwise.", "type": "boolean", "default": false }, @@ -2062,7 +2062,7 @@ "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.", + "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": { @@ -2070,11 +2070,11 @@ "type": "string" }, "namespace": { - "description": "Namespace is the namespace used for the access review", + "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.", + "description": "reason is optional. It indicates why a request was allowed or denied.", "type": "string" } } @@ -2100,12 +2100,12 @@ "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta" }, "spec": { - "description": "Spec adds information about how to conduct the check", + "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", + "description": "status is completed by the server to tell which permissions you have", "default": {}, "$ref": "#/definitions/com.github.openshift.api.authorization.v1.SubjectRulesReviewStatus" } @@ -2121,7 +2121,7 @@ ], "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.", + "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", @@ -2129,7 +2129,7 @@ } }, "scopes": { - "description": "Scopes to use for the evaluation. Empty means \"use the unscoped (full) permissions of the user/groups\".", + "description": "scopes to use for the evaluation. Empty means \"use the unscoped (full) permissions of the user/groups\".", "type": "array", "items": { "type": "string", @@ -2137,7 +2137,7 @@ } }, "user": { - "description": "User is optional. At least one of User and Groups must be specified.", + "description": "user is optional. At least one of User and Groups must be specified.", "type": "string", "default": "" } @@ -2151,11 +2151,11 @@ ], "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.", + "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", + "description": "rules is the list of rules (no particular sort) that are allowed for the subject", "type": "array", "items": { "default": {}, @@ -2174,7 +2174,7 @@ ], "properties": { "groups": { - "description": "Groups specifies a list of literal group names.", + "description": "groups specifies a list of literal group names.", "type": "array", "items": { "type": "string", @@ -2190,7 +2190,7 @@ } }, "users": { - "description": "Users specifies a list of literal user names.", + "description": "users specifies a list of literal user names.", "type": "array", "items": { "type": "string", @@ -2261,11 +2261,11 @@ "type": "object", "properties": { "revision": { - "description": "Revision is the git source revision information of the trigger.", + "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.", + "description": "secret is the obfuscated webhook secret that triggered a build.", "type": "string" } } @@ -2324,12 +2324,12 @@ "type": "string" }, "status": { - "description": "Status of the condition, one of True, False, Unknown.", + "description": "status of the condition, one of True, False, Unknown.", "type": "string", "default": "" }, "type": { - "description": "Type of build condition.", + "description": "type of build condition.", "type": "string", "default": "" } @@ -2446,7 +2446,7 @@ "$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\".", + "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": { @@ -2486,7 +2486,7 @@ ], "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.", + "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": {}, @@ -2575,7 +2575,7 @@ "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.", + "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": { @@ -2620,7 +2620,7 @@ } }, "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).", + "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": { @@ -2668,7 +2668,7 @@ "$ref": "#/definitions/com.github.openshift.api.build.v1.BinaryBuildSource" }, "dockerStrategyOptions": { - "description": "DockerStrategyOptions contains additional docker-strategy specific options for the build", + "description": "dockerStrategyOptions contains additional docker-strategy specific options for the build", "$ref": "#/definitions/com.github.openshift.api.build.v1.DockerStrategyOptions" }, "env": { @@ -2702,7 +2702,7 @@ "$ref": "#/definitions/com.github.openshift.api.build.v1.SourceRevision" }, "sourceStrategyOptions": { - "description": "SourceStrategyOptions contains additional source-strategy specific options for the build", + "description": "sourceStrategyOptions contains additional source-strategy specific options for the build", "$ref": "#/definitions/com.github.openshift.api.build.v1.SourceStrategyOptions" }, "triggeredBy": { @@ -2856,7 +2856,7 @@ "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time" }, "conditions": { - "description": "Conditions represents the latest available observations of a build's current state.", + "description": "conditions represents the latest available observations of a build's current state.", "type": "array", "items": { "default": {}, @@ -2947,7 +2947,7 @@ "$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", + "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": { @@ -2965,7 +2965,7 @@ "type": "object", "properties": { "bitbucketWebHook": { - "description": "BitbucketWebHook represents data for a Bitbucket webhook that fired a specific build.", + "description": "bitbucketWebHook represents data for a Bitbucket webhook that fired a specific build.", "$ref": "#/definitions/com.github.openshift.api.build.v1.BitbucketWebHookCause" }, "genericWebHook": { @@ -2973,11 +2973,11 @@ "$ref": "#/definitions/com.github.openshift.api.build.v1.GenericWebHookCause" }, "githubWebHook": { - "description": "gitHubWebHook represents data for a GitHub webhook that fired a specific build.", + "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.", + "description": "gitlabWebHook represents data for a GitLab webhook that fired a specific build.", "$ref": "#/definitions/com.github.openshift.api.build.v1.GitLabWebHookCause" }, "imageChangeBuild": { @@ -3163,11 +3163,11 @@ "type": "object", "properties": { "revision": { - "description": "Revision is the git source revision information of the trigger.", + "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.", + "description": "secret is the obfuscated webhook secret that triggered a build.", "type": "string" } } @@ -3333,7 +3333,7 @@ "type": "object", "properties": { "dockerStrategyOptions": { - "description": "DockerStrategyOptions contains additional docker-strategy specific options for the build", + "description": "dockerStrategyOptions contains additional docker-strategy specific options for the build", "$ref": "#/definitions/com.github.openshift.api.build.v1.DockerStrategyOptions" }, "env": { @@ -3441,7 +3441,7 @@ "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", + "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": {}, @@ -3460,11 +3460,11 @@ "type": "object", "properties": { "revision": { - "description": "Revision is the git source revision information of the trigger.", + "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.", + "description": "secret is the obfuscated webhook secret that triggered a build.", "type": "string" } } @@ -3691,11 +3691,11 @@ } }, "jenkinsfile": { - "description": "Jenkinsfile defines the optional raw contents of a Jenkinsfile which defines a Jenkins pipeline build.", + "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.", + "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" } } @@ -3744,7 +3744,7 @@ ], "properties": { "name": { - "description": "Name is the name of the resource in the same namespace being referenced", + "description": "name is the name of the resource in the same namespace being referenced", "type": "string", "default": "" } @@ -3844,7 +3844,7 @@ ], "properties": { "git": { - "description": "Git contains information about git-based build source", + "description": "git contains information about git-based build source", "$ref": "#/definitions/com.github.openshift.api.build.v1.GitSourceRevision" }, "type": { @@ -4153,6 +4153,9 @@ "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", @@ -4210,7 +4213,7 @@ "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.", + "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": {}, @@ -4297,11 +4300,11 @@ ], "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.", + "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", + "description": "location is the path to a configuration file that contains the plugin's configuration", "type": "string", "default": "" } @@ -4432,11 +4435,11 @@ "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.", + "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.", + "description": "policyFile is a path to the file that defines the audit policy configuration.", "type": "string", "default": "" }, @@ -4542,7 +4545,7 @@ "$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.", + "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": {}, @@ -4591,7 +4594,7 @@ "$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.", + "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": {}, @@ -4820,7 +4823,7 @@ "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta" }, "spec": { - "description": "Spec holds user-settable values for the build controller configuration", + "description": "spec holds user-settable values for the build controller configuration", "default": {}, "$ref": "#/definitions/com.github.openshift.api.config.v1.BuildSpec" } @@ -4830,11 +4833,11 @@ "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.", + "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", + "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": {}, @@ -4842,11 +4845,11 @@ } }, "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.", + "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.", + "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": {}, @@ -4854,7 +4857,7 @@ } }, "resources": { - "description": "Resources defines resource requirements to execute the build.", + "description": "resources defines resource requirements to execute the build.", "default": {}, "$ref": "#/definitions/io.k8s.api.core.v1.ResourceRequirements" } @@ -4898,7 +4901,7 @@ "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.", + "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": {}, @@ -4906,7 +4909,7 @@ } }, "nodeSelector": { - "description": "NodeSelector is a selector which must be true for the build pod to fit on a node", + "description": "nodeSelector is a selector which must be true for the build pod to fit on a node", "type": "object", "additionalProperties": { "type": "string", @@ -4927,17 +4930,17 @@ "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.", + "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", + "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", + "description": "buildOverrides controls override settings for builds", "default": {}, "$ref": "#/definitions/com.github.openshift.api.config.v1.BuildOverrides" } @@ -4952,12 +4955,12 @@ ], "properties": { "certFile": { - "description": "CertFile is a file containing a PEM-encoded certificate", + "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", + "description": "keyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile", "type": "string", "default": "" } @@ -5071,7 +5074,7 @@ ], "properties": { "promql": { - "description": "promQL represents a cluster condition based on PromQL.", + "description": "promql represents a cluster condition based on PromQL.", "$ref": "#/definitions/com.github.openshift.api.config.v1.PromQLClusterCondition" }, "type": { @@ -5692,7 +5695,7 @@ ], "properties": { "key": { - "description": "Key allows pointing to a specific key/value inside of the configmap. This is useful for logical file references.", + "description": "key allows pointing to a specific key/value inside of the configmap. This is useful for logical file references.", "type": "string" }, "name": { @@ -6058,12 +6061,12 @@ "default": "" }, "certFile": { - "description": "CertFile is a file containing a PEM-encoded certificate", + "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", + "description": "keyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile", "type": "string", "default": "" }, @@ -6092,12 +6095,12 @@ "default": "" }, "certFile": { - "description": "CertFile is a file containing a PEM-encoded certificate", + "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", + "description": "keyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile", "type": "string", "default": "" }, @@ -6164,7 +6167,7 @@ "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.", + "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" } @@ -6367,12 +6370,12 @@ ], "properties": { "featureGate": { - "description": "FeatureGate is the name of the FeatureGate as it appears in The FeatureGate CR instance.", + "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", + "description": "tests contains an item for every TestName", "type": "array", "items": { "default": {}, @@ -6689,22 +6692,22 @@ ], "properties": { "bindAddress": { - "description": "BindAddress is the ip:port to serve on", + "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\"", + "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", + "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", + "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", @@ -6712,26 +6715,26 @@ } }, "clientCA": { - "description": "ClientCA is the certificate bundle for all the signers that you'll recognize for incoming client certificates", + "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", + "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.", + "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", + "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", + "description": "namedCertificates is a list of certificates to use to secure requests to specific hostnames", "type": "array", "items": { "default": {}, @@ -6739,7 +6742,7 @@ } }, "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.", + "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 @@ -6789,23 +6792,23 @@ "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", + "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", + "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", + "description": "location is where the cluster has been deployed", "type": "string" }, "providerType": { - "description": "ProviderType indicates the type of cluster that was created", + "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.", + "description": "resourceGroupName is the Resource Group for new IBMCloud resources created for the cluster.", "type": "string" }, "serviceEndpoints": { @@ -7173,12 +7176,12 @@ ], "properties": { "name": { - "description": "Name defines the name of the label. It must have non-zero length.", + "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.", + "description": "value defines the literal value of the label.", "type": "string" } } @@ -7885,11 +7888,11 @@ "type": "object", "properties": { "machine": { - "description": "Machine contains MTU migration configuration for the machine's uplink.", + "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.", + "description": "network contains MTU migration configuration for the default network.", "$ref": "#/definitions/com.github.openshift.api.config.v1.MTUMigrationValues" } } @@ -7942,17 +7945,17 @@ ], "properties": { "certFile": { - "description": "CertFile is a file containing a PEM-encoded certificate", + "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", + "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.", + "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", @@ -8094,11 +8097,11 @@ "type": "object", "properties": { "mtu": { - "description": "MTU is the MTU configuration that is being deployed.", + "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.", + "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" } } @@ -8131,7 +8134,7 @@ "$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.", + "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": "" }, @@ -8164,7 +8167,7 @@ "x-kubernetes-list-type": "atomic" }, "clusterNetworkMTU": { - "description": "ClusterNetworkMTU is the MTU for inter-pod networking.", + "description": "clusterNetworkMTU is the MTU for inter-pod networking.", "type": "integer", "format": "int32" }, @@ -8183,11 +8186,11 @@ "x-kubernetes-patch-strategy": "merge" }, "migration": { - "description": "Migration contains the cluster network migration configuration.", + "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).", + "description": "networkType is the plugin that is deployed (e.g. OVNKubernetes).", "type": "string" }, "serviceNetwork": { @@ -8267,7 +8270,7 @@ "type": "object", "properties": { "cgroupMode": { - "description": "CgroupMode determines the cgroups version on the node", + "description": "cgroupMode determines the cgroups version on the node", "type": "string" }, "minimumKubeletVersion": { @@ -8276,7 +8279,7 @@ "default": "" }, "workerLatencyProfile": { - "description": "WorkerLatencyProfile determins the how fast the kubelet is updating the status and corresponding reaction of the cluster", + "description": "workerLatencyProfile determins the how fast the kubelet is updating the status and corresponding reaction of the cluster", "type": "string" } } @@ -8657,27 +8660,27 @@ ], "properties": { "clientID": { - "description": "ClientID is the identifier of the OIDC client from the OIDC provider", + "description": "clientID is the identifier of the OIDC client from the OIDC provider", "type": "string", "default": "" }, "clientSecret": { - "description": "ClientSecret refers to a secret in the `openshift-config` namespace that contains the client secret in the `clientSecret` key of the `.data` field", + "description": "clientSecret refers to a secret in the `openshift-config` namespace that contains the client secret in the `clientSecret` key of the `.data` field", "default": {}, "$ref": "#/definitions/com.github.openshift.api.config.v1.SecretNameReference" }, "componentName": { - "description": "ComponentName is the name of the component that is supposed to consume this client configuration", + "description": "componentName is the name of the component that is supposed to consume this client configuration", "type": "string", "default": "" }, "componentNamespace": { - "description": "ComponentNamespace is the namespace of the component that is supposed to consume this client configuration", + "description": "componentNamespace is the namespace of the component that is supposed to consume this client configuration", "type": "string", "default": "" }, "extraScopes": { - "description": "ExtraScopes is an optional set of scopes to request tokens with.", + "description": "extraScopes is an optional set of scopes to request tokens with.", "type": "array", "items": { "type": "string", @@ -8696,7 +8699,7 @@ ], "properties": { "clientID": { - "description": "ClientID is the identifier of the OIDC client from the OIDC provider", + "description": "clientID is the identifier of the OIDC client from the OIDC provider", "type": "string", "default": "" }, @@ -8722,17 +8725,17 @@ ], "properties": { "componentName": { - "description": "ComponentName is the name of the component that will consume a client configuration.", + "description": "componentName is the name of the component that will consume a client configuration.", "type": "string", "default": "" }, "componentNamespace": { - "description": "ComponentNamespace is the namespace of the component that will consume a client configuration.", + "description": "componentNamespace is the namespace of the component that will consume a client configuration.", "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.", + "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": {}, @@ -8744,7 +8747,7 @@ "x-kubernetes-list-type": "map" }, "consumingUsers": { - "description": "ConsumingUsers is a slice of ServiceAccounts that need to have read permission on the `clientSecret` secret.", + "description": "consumingUsers is a slice of ServiceAccounts that need to have read permission on the `clientSecret` secret.", "type": "array", "items": { "type": "string", @@ -8753,7 +8756,7 @@ "x-kubernetes-list-type": "set" }, "currentOIDCClients": { - "description": "CurrentOIDCClients is a list of clients that the component is currently using.", + "description": "currentOIDCClients is a list of clients that the component is currently using.", "type": "array", "items": { "default": {}, @@ -8777,12 +8780,12 @@ ], "properties": { "claimMappings": { - "description": "ClaimMappings describes rules on how to transform information from an ID token into a cluster identity", + "description": "claimMappings describes rules on how to transform information from an ID token into a cluster identity", "default": {}, "$ref": "#/definitions/com.github.openshift.api.config.v1.TokenClaimMappings" }, "claimValidationRules": { - "description": "ClaimValidationRules are rules that are applied to validate token claims to authenticate users.", + "description": "claimValidationRules are rules that are applied to validate token claims to authenticate users.", "type": "array", "items": { "default": {}, @@ -8791,17 +8794,17 @@ "x-kubernetes-list-type": "atomic" }, "issuer": { - "description": "Issuer describes atributes of the OIDC token issuer", + "description": "issuer describes atributes of the OIDC token issuer", "default": {}, "$ref": "#/definitions/com.github.openshift.api.config.v1.TokenIssuer" }, "name": { - "description": "Name of the OIDC provider", + "description": "name of the OIDC provider", "type": "string", "default": "" }, "oidcClients": { - "description": "OIDCClients contains configuration for the platform's clients that need to request tokens from the issuer", + "description": "oidcClients contains configuration for the platform's clients that need to request tokens from the issuer", "type": "array", "items": { "default": {}, @@ -9243,23 +9246,23 @@ ], "properties": { "alibabaCloud": { - "description": "AlibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider.", + "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.", + "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.", + "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.", + "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.", + "description": "equinixMetal contains settings specific to the Equinix Metal infrastructure provider.", "$ref": "#/definitions/com.github.openshift.api.config.v1.EquinixMetalPlatformSpec" }, "external": { @@ -9267,31 +9270,31 @@ "$ref": "#/definitions/com.github.openshift.api.config.v1.ExternalPlatformSpec" }, "gcp": { - "description": "GCP contains settings specific to the Google Cloud Platform infrastructure provider.", + "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.", + "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.", + "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.", + "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.", + "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.", + "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.", + "description": "powervs contains settings specific to the IBM Power Systems Virtual Servers infrastructure provider.", "$ref": "#/definitions/com.github.openshift.api.config.v1.PowerVSPlatformSpec" }, "type": { @@ -9300,7 +9303,7 @@ "default": "" }, "vsphere": { - "description": "VSphere contains settings specific to the VSphere infrastructure provider.", + "description": "vsphere contains settings specific to the VSphere infrastructure provider.", "$ref": "#/definitions/com.github.openshift.api.config.v1.VSpherePlatformSpec" } } @@ -9313,55 +9316,55 @@ ], "properties": { "alibabaCloud": { - "description": "AlibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider.", + "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.", + "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.", + "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.", + "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.", + "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.", + "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.", + "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.", + "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.", + "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.", + "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.", + "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.", + "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.", + "description": "powervs contains settings specific to the Power Systems Virtual Servers infrastructure provider.", "$ref": "#/definitions/com.github.openshift.api.config.v1.PowerVSPlatformStatus" }, "type": { @@ -9370,7 +9373,7 @@ "default": "" }, "vsphere": { - "description": "VSphere contains settings specific to the VSphere infrastructure provider.", + "description": "vsphere contains settings specific to the VSphere infrastructure provider.", "$ref": "#/definitions/com.github.openshift.api.config.v1.VSpherePlatformStatus" } } @@ -9402,11 +9405,11 @@ ], "properties": { "cisInstanceCRN": { - "description": "CISInstanceCRN is the CRN of the Cloud Internet Services instance managing the DNS zone for the cluster's base domain", + "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", + "description": "dnsInstanceCRN is the CRN of the DNS Services instance managing the DNS zone for the cluster's base domain", "type": "string" }, "region": { @@ -9466,12 +9469,12 @@ ], "properties": { "claim": { - "description": "Claim is a JWT token claim to be used in the mapping", + "description": "claim is a JWT token claim to be used in the mapping", "type": "string", "default": "" }, "prefix": { - "description": "Prefix is a string to prefix the value from the token in the result of the claim mapping.\n\nBy default, no prefixing occurs.\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\".", + "description": "prefix is a string to prefix the value from the token in the result of the claim mapping.\n\nBy default, no prefixing occurs.\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": "" } @@ -9577,7 +9580,7 @@ ], "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.", + "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": "" } @@ -9604,7 +9607,7 @@ "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta" }, "spec": { - "description": "Spec holds user-settable values for the proxy configuration", + "description": "spec holds user-settable values for the proxy configuration", "default": {}, "$ref": "#/definitions/com.github.openshift.api.config.v1.ProxySpec" }, @@ -9802,22 +9805,22 @@ ], "properties": { "ca": { - "description": "CA is the CA for verifying TLS connections", + "description": "ca is the CA for verifying TLS connections", "type": "string", "default": "" }, "certFile": { - "description": "CertFile is a file containing a PEM-encoded certificate", + "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", + "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", + "description": "url is the remote URL to connect to", "type": "string", "default": "" } @@ -10024,7 +10027,7 @@ "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.", + "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 }, @@ -10072,22 +10075,22 @@ ], "properties": { "bindAddress": { - "description": "BindAddress is the ip:port to serve on", + "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\"", + "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", + "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", + "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", @@ -10095,20 +10098,20 @@ } }, "clientCA": { - "description": "ClientCA is the certificate bundle for all the signers that you'll recognize for incoming client certificates", + "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", + "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", + "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", + "description": "namedCertificates is a list of certificates to use to secure requests to specific hostnames", "type": "array", "items": { "default": {}, @@ -10147,22 +10150,22 @@ ], "properties": { "env": { - "description": "Env specifies an envvar containing the cleartext value, or an encrypted value if the keyFile is specified.", + "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.", + "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.", + "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.", + "description": "value specifies the cleartext value, or an encrypted value if keyFile is specified.", "type": "string", "default": "" } @@ -10179,22 +10182,22 @@ ], "properties": { "env": { - "description": "Env specifies an envvar containing the cleartext value, or an encrypted value if the keyFile is specified.", + "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.", + "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.", + "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.", + "description": "value specifies the cleartext value, or an encrypted value if keyFile is specified.", "type": "string", "default": "" } @@ -10283,7 +10286,7 @@ ], "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.", + "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": "" } @@ -10327,7 +10330,7 @@ ], "properties": { "testsForFeatureGates": { - "description": "TestsForFeatureGates is a list, indexed by FeatureGate and includes information about testing.", + "description": "testsForFeatureGates is a list, indexed by FeatureGate and includes information about testing.", "type": "array", "items": { "default": {}, @@ -10346,7 +10349,7 @@ ], "properties": { "claim": { - "description": "Claim is a JWT token claim to be used in the mapping", + "description": "claim is a JWT token claim to be used in the mapping", "type": "string", "default": "" } @@ -10356,12 +10359,12 @@ "type": "object", "properties": { "groups": { - "description": "Groups is a name of the claim that should be used to construct groups for the cluster identity. The referenced claim must use array of strings values.", + "description": "groups is a name of the claim that should be used to construct groups for the cluster identity. The referenced claim must use array of strings values.", "default": {}, "$ref": "#/definitions/com.github.openshift.api.config.v1.PrefixedClaimMapping" }, "username": { - "description": "Username is a name of the claim that should be used to construct usernames for the cluster identity.\n\nDefault value: \"sub\"", + "description": "username is a name of the claim that should be used to construct usernames for the cluster identity.\n\nDefault value: \"sub\"", "default": {}, "$ref": "#/definitions/com.github.openshift.api.config.v1.UsernameClaimMapping" } @@ -10375,11 +10378,11 @@ ], "properties": { "requiredClaim": { - "description": "RequiredClaim allows configuring a required claim name and its expected value", + "description": "requiredClaim allows configuring a required claim name and its expected value", "$ref": "#/definitions/com.github.openshift.api.config.v1.TokenRequiredClaim" }, "type": { - "description": "Type sets the type of the validation rule", + "description": "type sets the type of the validation rule", "type": "string", "default": "" } @@ -10414,7 +10417,7 @@ ], "properties": { "audiences": { - "description": "Audiences is an array of audiences that the token was issued for. Valid tokens must include at least one of these values in their \"aud\" claim. Must be set to exactly one value.", + "description": "audiences is an array of audiences that the token was issued for. Valid tokens must include at least one of these values in their \"aud\" claim. Must be set to exactly one value.", "type": "array", "items": { "type": "string", @@ -10442,12 +10445,12 @@ ], "properties": { "claim": { - "description": "Claim is a name of a required claim. Only claims with string values are supported.", + "description": "claim is a name of a required claim. Only claims with string values are supported.", "type": "string", "default": "" }, "requiredValue": { - "description": "RequiredValue is the required value for the claim.", + "description": "requiredValue is the required value for the claim.", "type": "string", "default": "" } @@ -10533,7 +10536,7 @@ ], "properties": { "claim": { - "description": "Claim is a JWT token claim to be used in the mapping", + "description": "claim is a JWT token claim to be used in the mapping", "type": "string", "default": "" }, @@ -10541,7 +10544,7 @@ "$ref": "#/definitions/com.github.openshift.api.config.v1.UsernamePrefix" }, "prefixPolicy": { - "description": "PrefixPolicy specifies how a prefix should apply.\n\nBy default, claims other than `email` will be prefixed with the issuer URL to prevent naming clashes with other plugins.\n\nSet to \"NoPrefix\" to disable prefixing.\n\nExample:\n (1) `prefix` is set to \"myoidc:\" and `claim` is set to \"username\".\n If the JWT claim `username` contains value `userA`, the resulting\n mapped value will be \"myoidc:userA\".\n (2) `prefix` is set to \"myoidc:\" and `claim` is set to \"email\". If the\n JWT `email` claim contains value \"userA@myoidc.tld\", the resulting\n mapped value will be \"myoidc:userA@myoidc.tld\".\n (3) `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 (a) \"username\": the mapped value will be \"https://myoidc.tld#userA\"\n (b) \"email\": the mapped value will be \"userA@myoidc.tld\"", + "description": "prefixPolicy specifies how a prefix should apply.\n\nBy default, claims other than `email` will be prefixed with the issuer URL to prevent naming clashes with other plugins.\n\nSet to \"NoPrefix\" to disable prefixing.\n\nExample:\n (1) `prefix` is set to \"myoidc:\" and `claim` is set to \"username\".\n If the JWT claim `username` contains value `userA`, the resulting\n mapped value will be \"myoidc:userA\".\n (2) `prefix` is set to \"myoidc:\" and `claim` is set to \"email\". If the\n JWT `email` claim contains value \"userA@myoidc.tld\", the resulting\n mapped value will be \"myoidc:userA@myoidc.tld\".\n (3) `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 (a) \"username\": the mapped value will be \"https://myoidc.tld#userA\"\n (b) \"email\": the mapped value will be \"userA@myoidc.tld\"", "type": "string", "default": "" } @@ -10670,7 +10673,7 @@ "default": "" }, "topology": { - "description": "Topology describes a given failure domain using vSphere constructs", + "description": "topology describes a given failure domain using vSphere constructs", "default": {}, "$ref": "#/definitions/com.github.openshift.api.config.v1.VSpherePlatformTopology" }, @@ -11138,17 +11141,17 @@ "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.", + "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.", + "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.", + "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": "" }, @@ -11164,7 +11167,8 @@ "type": "object", "required": [ "fulcioCAData", - "rekorKeyData" + "rekorKeyData", + "fulcioSubject" ], "properties": { "fulcioCAData": { @@ -11540,7 +11544,7 @@ ], "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.", + "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" } @@ -11554,15 +11558,15 @@ ], "properties": { "retentionNumber": { - "description": "RetentionNumber configures the retention policy based on the number of backups", + "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", + "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", + "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": [ @@ -11589,7 +11593,7 @@ ], "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.", + "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" } @@ -11603,7 +11607,7 @@ ], "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.", + "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": { @@ -12829,6 +12833,9 @@ "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.", @@ -12855,6 +12862,9 @@ }, "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", @@ -13389,11 +13399,11 @@ "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.", + "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.", + "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": {}, @@ -13401,15 +13411,15 @@ } }, "dockerImageManifest": { - "description": "DockerImageManifest is the raw JSON of the manifest", + "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.", + "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.", + "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": {}, @@ -13417,20 +13427,20 @@ } }, "dockerImageMetadata": { - "description": "DockerImageMetadata contains metadata about this image", + "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\"", + "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.", + "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.", + "description": "dockerImageSignatures provides the signatures as opaque blobs. This is a part of manifest schema v1.", "type": "array", "items": { "type": "string", @@ -13447,7 +13457,7 @@ "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta" }, "signatures": { - "description": "Signatures holds all signatures of the image.", + "description": "signatures holds all signatures of the image.", "type": "array", "items": { "default": {}, @@ -13497,26 +13507,26 @@ ], "properties": { "from": { - "description": "From is the source of an image to import; only kind DockerImage is allowed", + "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", + "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", + "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", + "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", + "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" } } @@ -13529,11 +13539,11 @@ ], "properties": { "image": { - "description": "Image is the metadata of that image, if the image was located", + "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", + "description": "manifests holds sub-manifests metadata when importing a manifest list", "type": "array", "items": { "default": {}, @@ -13541,12 +13551,12 @@ } }, "status": { - "description": "Status is the status of the image import, including errors encountered while retrieving the image", + "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", + "description": "tag is the tag this image was located under, if any", "type": "string" } } @@ -13561,17 +13571,17 @@ ], "properties": { "mediaType": { - "description": "MediaType of the referenced object.", + "description": "mediaType of the referenced object.", "type": "string", "default": "" }, "name": { - "description": "Name of the layer as defined by the underlying store.", + "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.", + "description": "size of the layer in bytes as defined by the underlying store.", "type": "integer", "format": "int64", "default": 0 @@ -13587,12 +13597,12 @@ ], "properties": { "mediaType": { - "description": "MediaType of the referenced object.", + "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.", + "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" } @@ -13610,7 +13620,7 @@ "type": "string" }, "items": { - "description": "Items is a list of images", + "description": "items is a list of images", "type": "array", "items": { "default": {}, @@ -13654,33 +13664,33 @@ ], "properties": { "architecture": { - "description": "Architecture specifies the supported CPU architecture, for example `amd64` or `ppc64le`.", + "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.", + "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.", + "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.", + "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`.", + "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.", + "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" } } @@ -13698,7 +13708,7 @@ "type": "string" }, "conditions": { - "description": "Conditions represent the latest available observations of a signature's current state.", + "description": "conditions represent the latest available observations of a signature's current state.", "type": "array", "items": { "default": {}, @@ -13770,12 +13780,12 @@ "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta" }, "spec": { - "description": "Spec describes the desired state of this stream", + "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", + "description": "status describes the current state of this stream", "default": {}, "$ref": "#/definitions/com.github.openshift.api.image.v1.ImageStreamStatus" } @@ -13793,7 +13803,7 @@ "type": "string" }, "image": { - "description": "Image associated with the ImageStream and image name.", + "description": "image associated with the ImageStream and image name.", "default": {}, "$ref": "#/definitions/com.github.openshift.api.image.v1.Image" }, @@ -13830,12 +13840,12 @@ "$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", + "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", + "description": "status is the result of importing the image", "default": {}, "$ref": "#/definitions/com.github.openshift.api.image.v1.ImageStreamImportStatus" } @@ -13849,7 +13859,7 @@ ], "properties": { "images": { - "description": "Images are a list of individual images to import.", + "description": "images are a list of individual images to import.", "type": "array", "items": { "default": {}, @@ -13857,12 +13867,12 @@ } }, "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.", + "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.", + "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" } } @@ -13872,7 +13882,7 @@ "type": "object", "properties": { "images": { - "description": "Images is set with the result of importing spec.images", + "description": "images is set with the result of importing spec.images", "type": "array", "items": { "default": {}, @@ -13880,11 +13890,11 @@ } }, "import": { - "description": "Import is the image stream that was successfully updated or created when 'to' was set.", + "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", + "description": "repository is set if spec.repository was set to the outcome of the import", "$ref": "#/definitions/com.github.openshift.api.image.v1.RepositoryImportStatus" } } @@ -13940,7 +13950,7 @@ "type": "string" }, "items": { - "description": "Items is a list of imageStreams", + "description": "items is a list of imageStreams", "type": "array", "items": { "default": {}, @@ -13971,7 +13981,7 @@ "type": "string" }, "image": { - "description": "Image is a container image.", + "description": "image is a container image.", "default": {}, "$ref": "#/definitions/com.github.openshift.api.image.v1.Image" }, @@ -13985,7 +13995,7 @@ "$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.", + "description": "tag is a string value this image can be located with inside the stream.", "type": "string", "default": "" } @@ -14024,16 +14034,16 @@ ], "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", + "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.", + "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.", + "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": {}, @@ -14109,7 +14119,7 @@ "type": "string" }, "items": { - "description": "Items is the list of image stream tags", + "description": "items is the list of image stream tags", "type": "array", "items": { "default": {}, @@ -14175,7 +14185,7 @@ "type": "string" }, "items": { - "description": "Items is the list of image stream tags", + "description": "items is the list of image stream tags", "type": "array", "items": { "default": {}, @@ -14202,7 +14212,7 @@ ], "properties": { "conditions": { - "description": "Conditions is an array of conditions that apply to the tag event list.", + "description": "conditions is an array of conditions that apply to the tag event list.", "type": "array", "items": { "default": {}, @@ -14218,7 +14228,7 @@ } }, "tag": { - "description": "Tag is the tag for which the history is recorded", + "description": "tag is the tag for which the history is recorded", "type": "string", "default": "" } @@ -14232,21 +14242,21 @@ ], "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", + "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", + "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", + "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", + "description": "referencePolicy defines how other components should consume the image", "default": {}, "$ref": "#/definitions/com.github.openshift.api.image.v1.TagReferencePolicy" } @@ -14257,7 +14267,7 @@ "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.", + "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", @@ -14265,7 +14275,7 @@ } }, "images": { - "description": "Images is a list of images successfully retrieved by the import of the repository.", + "description": "images is a list of images successfully retrieved by the import of the repository.", "type": "array", "items": { "default": {}, @@ -14273,7 +14283,7 @@ } }, "status": { - "description": "Status reflects whether any failure occurred during import", + "description": "status reflects whether any failure occurred during import", "default": {}, "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Status" } @@ -14334,12 +14344,12 @@ "type": "string" }, "status": { - "description": "Status of the condition, one of True, False, Unknown.", + "description": "status of the condition, one of True, False, Unknown.", "type": "string", "default": "" }, "type": { - "description": "Type of signature condition, Complete or Failed.", + "description": "type of signature condition, Complete or Failed.", "type": "string", "default": "" } @@ -14354,7 +14364,7 @@ "type": "string" }, "organization": { - "description": "Organization name.", + "description": "organization name.", "type": "string" } } @@ -14368,7 +14378,7 @@ "type": "string" }, "organization": { - "description": "Organization name.", + "description": "organization name.", "type": "string" } } @@ -14385,7 +14395,7 @@ "type": "string" }, "organization": { - "description": "Organization name.", + "description": "organization name.", "type": "string" }, "publicKeyID": { @@ -14406,22 +14416,22 @@ ], "properties": { "created": { - "description": "Created holds the time the TagEvent was 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", + "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", + "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", + "description": "image is the image", "type": "string", "default": "" } @@ -14437,30 +14447,30 @@ ], "properties": { "generation": { - "description": "Generation is the spec tag generation that this status corresponds to", + "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.", + "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.", + "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.", + "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.", + "description": "status of the condition, one of True, False, Unknown.", "type": "string", "default": "" }, "type": { - "description": "Type of tag event condition, currently only ImportSuccess", + "description": "type of tag event condition, currently only ImportSuccess", "type": "string", "default": "" } @@ -14471,15 +14481,15 @@ "type": "object", "properties": { "importMode": { - "description": "ImportMode describes how to import an image manifest.", + "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.", + "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", + "description": "scheduled indicates to the server that this tag should be periodically checked to ensure it is up to date, and imported", "type": "boolean" } } @@ -14504,26 +14514,26 @@ "$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.", + "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.", + "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", + "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.", + "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.", + "description": "referencePolicy defines how other components should consume the image.", "default": {}, "$ref": "#/definitions/com.github.openshift.api.image.v1.TagReferencePolicy" } @@ -14537,7 +14547,7 @@ ], "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.", + "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": "" } @@ -14971,7 +14981,7 @@ "$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!", + "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" } @@ -15081,12 +15091,12 @@ "default": "" }, "certFile": { - "description": "CertFile is a file containing a PEM-encoded certificate", + "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", + "description": "keyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile", "type": "string", "default": "" }, @@ -15184,7 +15194,7 @@ ], "properties": { "certFile": { - "description": "CertFile is a file containing a PEM-encoded certificate", + "description": "certFile is a file containing a PEM-encoded certificate", "type": "string", "default": "" } @@ -15213,7 +15223,7 @@ "default": "" }, "rejectionMessage": { - "description": "RejectionMessage is the message shown when rejecting a client. If it is not a set, the default message is used.", + "description": "rejectionMessage is the message shown when rejecting a client. If it is not a set, the default message is used.", "type": "string", "default": "" } @@ -15304,7 +15314,7 @@ ], "properties": { "groupMembershipAttributes": { - "description": "GroupMembershipAttributes defines which attributes on an LDAP user entry will be interpreted as the groups it is a member of", + "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", @@ -15312,7 +15322,7 @@ } }, "userNameAttributes": { - "description": "UserNameAttributes defines which attributes on an LDAP user entry will be interpreted as its OpenShift user name.", + "description": "userNameAttributes defines which attributes on an LDAP user entry will be interpreted as its OpenShift user name.", "type": "array", "items": { "type": "string", @@ -15334,14 +15344,14 @@ ], "properties": { "pluginConfig": { - "description": "PluginConfig allows specifying a configuration file per admission control plugin", + "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.", + "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", @@ -15359,11 +15369,11 @@ ], "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.", + "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", + "description": "location is the path to a configuration file that contains the plugin's configuration", "type": "string", "default": "" } @@ -15377,7 +15387,7 @@ ], "properties": { "proxyClientInfo": { - "description": "ProxyClientInfo specifies the client cert/key to use when proxying to aggregated API servers", + "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" } @@ -15447,11 +15457,11 @@ "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.", + "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.", + "description": "policyFile is a path to the file that defines the audit policy configuration.", "type": "string", "default": "" }, @@ -15480,7 +15490,7 @@ ], "properties": { "groupMembershipAttributes": { - "description": "GroupMembershipAttributes defines which attributes on an LDAP user entry will be interpreted as the groups it is a member of", + "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", @@ -15488,7 +15498,7 @@ } }, "groupNameAttributes": { - "description": "GroupNameAttributes defines which attributes on an LDAP group entry will be interpreted as its name to use for an OpenShift group", + "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", @@ -15506,7 +15516,7 @@ "$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.", + "description": "userNameAttributes defines which attributes on an LDAP user entry will be interpreted as its OpenShift user name.", "type": "array", "items": { "type": "string", @@ -15535,17 +15545,17 @@ "type": "string" }, "ca": { - "description": "CA is the CA for verifying TLS connections", + "description": "ca is the CA for verifying TLS connections", "type": "string", "default": "" }, "certFile": { - "description": "CertFile is a file containing a PEM-encoded certificate", + "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", + "description": "keyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile", "type": "string", "default": "" }, @@ -15554,7 +15564,7 @@ "type": "string" }, "url": { - "description": "URL is the remote URL to connect to", + "description": "url is the remote URL to connect to", "type": "string", "default": "" } @@ -15690,12 +15700,12 @@ ], "properties": { "certFile": { - "description": "CertFile is a file containing a PEM-encoded certificate", + "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", + "description": "keyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile", "type": "string", "default": "" } @@ -15712,23 +15722,23 @@ ], "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.", + "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.", + "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.", + "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.", + "description": "qps controls the number of queries per second allowed for this connection.", "type": "number", "format": "float", "default": 0 @@ -15744,12 +15754,12 @@ ], "properties": { "cidr": { - "description": "CIDR defines the total range of a cluster networks address space.", + "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.", + "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 @@ -15766,7 +15776,7 @@ ], "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 \"*\".", + "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", @@ -15774,11 +15784,11 @@ } }, "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.", + "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.", + "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" } @@ -15794,17 +15804,17 @@ ], "properties": { "lockName": { - "description": "LockName is the resource name used to act as the lock for determining which controller instance should lead.", + "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\"", + "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\".", + "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" } @@ -15820,17 +15830,17 @@ ], "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.", + "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", + "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\"", + "description": "bindNetwork is the type of network to bind to - defaults to \"tcp4\", accepts \"tcp\", \"tcp4\", and \"tcp6\"", "type": "string", "default": "" } @@ -15848,7 +15858,7 @@ "type": "string" }, "disable": { - "description": "Disable turns off an admission plugin that is enabled by default.", + "description": "disable turns off an admission plugin that is enabled by default.", "type": "boolean", "default": false }, @@ -15882,17 +15892,17 @@ ], "properties": { "dockerShimRootDirectory": { - "description": "DockershimRootDirectory is the dockershim root directory.", + "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'", + "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.", + "description": "execHandlerName is the name of the handler to use for executing commands in containers.", "type": "string", "default": "" } @@ -15910,22 +15920,22 @@ ], "properties": { "address": { - "description": "Address is the advertised host:port for client connections to etcd", + "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", + "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", + "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", + "description": "servingInfo describes how to start serving the etcd master", "default": {}, "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.ServingInfo" }, @@ -15947,22 +15957,22 @@ ], "properties": { "ca": { - "description": "CA is a file containing trusted roots for the etcd server certificates", + "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", + "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", + "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", + "description": "urls are the URLs for etcd", "type": "array", "items": { "type": "string", @@ -15982,22 +15992,22 @@ ], "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'.", + "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.", + "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'.", + "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.", + "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": "" } @@ -16020,21 +16030,21 @@ "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.", + "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", + "description": "clientID is the oauth client ID", "type": "string", "default": "" }, "clientSecret": { - "description": "ClientSecret is the oauth client secret", + "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.", + "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": "" }, @@ -16043,7 +16053,7 @@ "type": "string" }, "organizations": { - "description": "Organizations optionally restricts which organizations are allowed to log in", + "description": "organizations optionally restricts which organizations are allowed to log in", "type": "array", "items": { "type": "string", @@ -16051,7 +16061,7 @@ } }, "teams": { - "description": "Teams optionally restricts which teams are allowed to log in. Format is /.", + "description": "teams optionally restricts which teams are allowed to log in. Format is /.", "type": "array", "items": { "type": "string", @@ -16075,17 +16085,17 @@ "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", + "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", + "description": "clientID is the oauth client ID", "type": "string", "default": "" }, "clientSecret": { - "description": "ClientSecret is the oauth client secret", + "description": "clientSecret is the oauth client secret", "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.StringSource" }, "kind": { @@ -16093,11 +16103,11 @@ "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", + "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", + "description": "url is the oauth server base URL", "type": "string", "default": "" } @@ -16117,16 +16127,16 @@ "type": "string" }, "clientID": { - "description": "ClientID is the oauth client ID", + "description": "clientID is the oauth client ID", "type": "string", "default": "" }, "clientSecret": { - "description": "ClientSecret is the oauth client secret", + "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", + "description": "hostedDomain is the optional Google App domain (e.g. \"mycompany.com\") to restrict logins to", "type": "string", "default": "" }, @@ -16145,12 +16155,12 @@ ], "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", + "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", + "description": "serviceAccountMethod is used for determining client authorization for service account oauth client. It must be either: deny, prompt", "type": "string", "default": "" } @@ -16165,12 +16175,12 @@ ], "properties": { "group": { - "description": "Group is the name of an API group", + "description": "group is the name of an API group", "type": "string", "default": "" }, "resource": { - "description": "Resource is the name of a resource.", + "description": "resource is the name of a resource.", "type": "string", "default": "" } @@ -16188,7 +16198,7 @@ "type": "string" }, "file": { - "description": "File is a reference to your htpasswd file", + "description": "file is a reference to your htpasswd file", "type": "string", "default": "" }, @@ -16213,22 +16223,22 @@ ], "properties": { "bindAddress": { - "description": "BindAddress is the ip:port to serve on", + "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\"", + "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", + "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", + "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", @@ -16236,27 +16246,27 @@ } }, "clientCA": { - "description": "ClientCA is the certificate bundle for all the signers that you'll recognize for incoming client certificates", + "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", + "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.", + "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", + "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", + "description": "namedCertificates is a list of certificates to use to secure requests to specific hostnames", "type": "array", "items": { "default": {}, @@ -16264,7 +16274,7 @@ } }, "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.", + "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 @@ -16293,17 +16303,17 @@ "default": false }, "mappingMethod": { - "description": "MappingMethod determines how identities from this provider are mapped to users", + "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", + "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", + "description": "provider contains the information about how to set up a specific identity provider", "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension" } } @@ -16317,12 +16327,12 @@ ], "properties": { "format": { - "description": "Format is the format of the name to be built for the system component", + "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", + "description": "latest determines if the latest tag will be pulled from the registry", "type": "boolean", "default": false } @@ -16339,11 +16349,11 @@ ], "properties": { "additionalTrustedCA": { - "description": "AdditionalTrustedCA is a path to a pem bundle file containing additional CAs that should be trusted during imagestream import.", + "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.", + "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": {}, @@ -16351,32 +16361,32 @@ } }, "disableScheduledImport": { - "description": "DisableScheduledImport allows scheduled background import of images to be disabled.", + "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.", + "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.", + "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.", + "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.", + "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.", + "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 @@ -16395,11 +16405,11 @@ ], "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.", + "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.", + "description": "parameters specifies a set of optional parameters to the Jenkins template.", "type": "object", "additionalProperties": { "type": "string", @@ -16407,17 +16417,17 @@ } }, "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.", + "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", + "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", + "description": "templateNamespace contains the namespace name where the Jenkins template is stored", "type": "string", "default": "" } @@ -16440,12 +16450,12 @@ "type": "string" }, "ca": { - "description": "CA is the CA for verifying TLS connections", + "description": "ca is the CA for verifying TLS connections", "type": "string", "default": "" }, "certFile": { - "description": "CertFile is a file containing a PEM-encoded certificate", + "description": "certFile is a file containing a PEM-encoded certificate", "type": "string", "default": "" }, @@ -16455,7 +16465,7 @@ "default": "" }, "keyFile": { - "description": "KeyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile", + "description": "keyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile", "type": "string", "default": "" }, @@ -16464,12 +16474,12 @@ "type": "string" }, "url": { - "description": "URL is the remote URL to connect to", + "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", + "description": "useKeystoneIdentity flag indicates that user should be authenticated by keystone ID, not by username", "type": "boolean", "default": false } @@ -16486,22 +16496,22 @@ ], "properties": { "ca": { - "description": "CA is the CA for verifying TLS connections to kubelets", + "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", + "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", + "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", + "description": "port is the port to connect to kubelets on", "type": "integer", "format": "int32", "default": 0 @@ -16527,7 +16537,7 @@ ], "properties": { "apiLevels": { - "description": "APILevels is a list of API levels that should be enabled on startup: v1 as examples", + "description": "apiLevels is a list of API levels that should be enabled on startup: v1 as examples", "type": "array", "items": { "type": "string", @@ -16535,7 +16545,7 @@ } }, "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.", + "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", @@ -16546,7 +16556,7 @@ } }, "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.", + "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", @@ -16557,7 +16567,7 @@ } }, "disabledAPIGroupVersions": { - "description": "DisabledAPIGroupVersions is a map of groups to the versions (or *) that should be disabled.", + "description": "disabledAPIGroupVersions is a map of groups to the versions (or *) that should be disabled.", "type": "object", "additionalProperties": { "type": "array", @@ -16568,28 +16578,28 @@ } }, "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.", + "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.", + "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.", + "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", + "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.", + "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", @@ -16600,17 +16610,17 @@ } }, "schedulerConfigFile": { - "description": "SchedulerConfigFile points to a file that describes how to set up the scheduler. If empty, you get the default scheduling rules.", + "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.", + "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", + "description": "servicesSubnet is the subnet to use for assigning service IPs", "type": "string", "default": "" } @@ -16627,7 +16637,7 @@ ], "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", + "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", @@ -16635,7 +16645,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. LDAP standard identity attribute is \"dn\"", "type": "array", "items": { "type": "string", @@ -16643,7 +16653,7 @@ } }, "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\"", + "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", @@ -16651,7 +16661,7 @@ } }, "preferredUsername": { - "description": "PreferredUsername is the list of attributes whose values should be used as the preferred username. LDAP standard login attribute is \"uid\"", + "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", @@ -16677,21 +16687,21 @@ "type": "string" }, "attributes": { - "description": "Attributes maps LDAP attributes to identities", + "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.", + "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.", + "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", + "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": "" }, @@ -16705,7 +16715,7 @@ "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\n ldap://host:port/basedn?attribute?scope?filter", "type": "string", "default": "" } @@ -16734,12 +16744,12 @@ "default": "" }, "filter": { - "description": "Filter is a valid LDAP search filter that retrieves all relevant entries from the LDAP server with the base DN", + "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.", + "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 @@ -16782,16 +16792,16 @@ "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.AugmentedActiveDirectoryConfig" }, "bindDN": { - "description": "BindDN is an optional DN to bind to the LDAP server with", + "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.", + "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", + "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": "" }, @@ -16846,12 +16856,12 @@ ], "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", + "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.", + "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": { @@ -16873,11 +16883,11 @@ ], "properties": { "openshiftLoopbackClientConnectionOverrides": { - "description": "OpenShiftLoopbackClientConnectionOverrides specifies client overrides for system components to loop back to this master.", + "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", + "description": "openshiftLoopbackKubeConfig is a .kubeconfig filename for system components to loopback to this master", "type": "string", "default": "" } @@ -16917,17 +16927,17 @@ ], "properties": { "admissionConfig": { - "description": "AdmissionConfig contains admission control plugin configuration.", + "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.", + "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", + "description": "apiLevels is a list of API levels that should be enabled on startup: v1 as examples", "type": "array", "items": { "type": "string", @@ -16939,22 +16949,22 @@ "type": "string" }, "auditConfig": { - "description": "AuditConfig holds information related to auditing capabilities.", + "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", + "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", + "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.", + "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": "" }, @@ -16971,7 +16981,7 @@ "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.DNSConfig" }, "etcdClientInfo": { - "description": "EtcdClientInfo contains information about how to connect to etcd", + "description": "etcdClientInfo contains information about how to connect to etcd", "default": {}, "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.EtcdConnectionInfo" }, @@ -16980,22 +16990,22 @@ "$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.", + "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", + "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", + "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.", + "description": "jenkinsPipelineConfig holds information about the default Jenkins template used for JenkinsPipeline build strategy.", "default": {}, "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.JenkinsPipelineConfig" }, @@ -17004,7 +17014,7 @@ "type": "string" }, "kubeletClientInfo": { - "description": "KubeletClientInfo contains information about how to connect to kubelets", + "description": "kubeletClientInfo contains information about how to connect to kubelets", "default": {}, "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.KubeletConnectionInfo" }, @@ -17014,17 +17024,17 @@ "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.KubernetesMasterConfig" }, "masterClients": { - "description": "MasterClients holds all the client connection information for controllers and other system components", + "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", + "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", + "description": "networkConfig to be passed to the compiled in network plugin", "default": {}, "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.MasterNetworkConfig" }, @@ -17033,27 +17043,27 @@ "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.OAuthConfig" }, "policyConfig": { - "description": "PolicyConfig holds information about where to locate critical pieces of bootstrapping policy", + "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", + "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", + "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", + "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", + "description": "servingInfo describes how to start serving", "default": {}, "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.HTTPServingInfo" }, @@ -17076,11 +17086,11 @@ ], "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.", + "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.", + "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": {}, @@ -17088,7 +17098,7 @@ } }, "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.", + "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", @@ -17096,17 +17106,17 @@ } }, "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.", + "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.", + "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", + "description": "networkPluginName is the name of the network plugin to use", "type": "string", "default": "" }, @@ -17116,7 +17126,7 @@ "default": "" }, "vxlanPort": { - "description": "VXLANPort is the VXLAN port used by the cluster defaults. If it is not set, 4789 is the default value", + "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" } @@ -17130,7 +17140,7 @@ ], "properties": { "dynamicProvisioningEnabled": { - "description": "DynamicProvisioningEnabled is a boolean that toggles dynamic provisioning off when false, defaults to true", + "description": "dynamicProvisioningEnabled is a boolean that toggles dynamic provisioning off when false, defaults to true", "type": "boolean" } } @@ -17145,17 +17155,17 @@ ], "properties": { "certFile": { - "description": "CertFile is a file containing a PEM-encoded certificate", + "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", + "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.", + "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", @@ -17175,24 +17185,24 @@ ], "properties": { "authenticationCacheSize": { - "description": "AuthenticationCacheSize indicates how many authentication results should be cached. If 0, the default cache size is used.", + "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", + "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.", + "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", + "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": "" } @@ -17225,7 +17235,7 @@ ], "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.", + "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 }, @@ -17234,27 +17244,27 @@ "type": "string" }, "authConfig": { - "description": "AuthConfig holds authn/authz configuration options", + "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.", + "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'.", + "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.", + "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.", + "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", @@ -17262,26 +17272,26 @@ } }, "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.", + "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.", + "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", + "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", + "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", + "description": "iptablesSyncPeriod is how often iptable rules are refreshed", "type": "string", "default": "" }, @@ -17290,7 +17300,7 @@ "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.", + "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", @@ -17301,16 +17311,16 @@ } }, "masterClientConnectionOverrides": { - "description": "MasterClientConnectionOverrides provides overrides to the client connection used to connect to the master.", + "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", + "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", + "description": "networkConfig provides network options for the node", "default": {}, "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.NodeNetworkConfig" }, @@ -17324,16 +17334,16 @@ "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", + "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", + "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.", + "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", @@ -17344,17 +17354,17 @@ } }, "servingInfo": { - "description": "ServingInfo describes how to start serving", + "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.", + "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", + "description": "volumeDirectory is the directory that volumes will be stored under", "type": "string", "default": "" } @@ -17375,7 +17385,7 @@ "default": 0 }, "networkPluginName": { - "description": "NetworkPluginName is a string specifying the networking plugin", + "description": "networkPluginName is a string specifying the networking plugin", "type": "string", "default": "" } @@ -17389,7 +17399,7 @@ ], "properties": { "localQuota": { - "description": "LocalQuota contains options for controlling local volume quota on the node.", + "description": "localQuota contains options for controlling local volume quota on the node.", "default": {}, "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.LocalQuota" } @@ -17412,22 +17422,22 @@ ], "properties": { "alwaysShowProviderSelection": { - "description": "AlwaysShowProviderSelection will force the provider selection page to render even when there is only a single provider.", + "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", + "description": "assetPublicURL is used for building valid client redirect URLs for external access", "type": "string", "default": "" }, "grantConfig": { - "description": "GrantConfig describes how to handle grants", + "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", + "description": "identityProviders is an ordered list of ways for a user to identify themselves", "type": "array", "items": { "default": {}, @@ -17435,29 +17445,29 @@ } }, "masterCA": { - "description": "MasterCA is the CA for verifying the TLS connection back to the MasterURL.", + "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", + "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", + "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.", + "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.", + "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", + "description": "tokenConfig contains options for authorization and access tokens", "default": {}, "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.TokenConfig" } @@ -17473,17 +17483,17 @@ ], "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.", + "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.", + "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.", + "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": "" } @@ -17500,7 +17510,7 @@ ], "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", + "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", @@ -17508,7 +17518,7 @@ } }, "id": { - "description": "ID is the list of claims whose values should be used as the user ID. Required. OpenID standard identity claim is \"sub\"", + "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", @@ -17516,7 +17526,7 @@ } }, "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", + "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", @@ -17524,7 +17534,7 @@ } }, "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", + "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", @@ -17551,26 +17561,26 @@ "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", + "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", + "description": "claims mappings", "default": {}, "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.OpenIDClaims" }, "clientID": { - "description": "ClientID is the oauth client ID", + "description": "clientID is the oauth client ID", "type": "string", "default": "" }, "clientSecret": { - "description": "ClientSecret is the oauth client secret", + "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.", + "description": "extraAuthorizeParameters are any custom parameters to add to the authorize request.", "type": "object", "additionalProperties": { "type": "string", @@ -17578,7 +17588,7 @@ } }, "extraScopes": { - "description": "ExtraScopes are any scopes to request in addition to the standard \"openid\" scope.", + "description": "extraScopes are any scopes to request in addition to the standard \"openid\" scope.", "type": "array", "items": { "type": "string", @@ -17590,7 +17600,7 @@ "type": "string" }, "urls": { - "description": "URLs to use to authenticate", + "description": "urls to use to authenticate", "default": {}, "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.OpenIDURLs" } @@ -17606,17 +17616,17 @@ ], "properties": { "authorize": { - "description": "Authorize is the oauth authorization URL", + "description": "authorize is the oauth authorization URL", "type": "string", "default": "" }, "token": { - "description": "Token is the oauth token granting URL", + "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", + "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": "" } @@ -17631,13 +17641,13 @@ ], "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", + "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", + "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": "" } @@ -17651,7 +17661,7 @@ ], "properties": { "userAgentMatchingConfig": { - "description": "UserAgentMatchingConfig controls how API calls from *voluntarily* identifying clients will be handled. THIS DOES NOT DEFEND AGAINST MALICIOUS CLIENTS!", + "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" } @@ -17668,22 +17678,22 @@ ], "properties": { "defaultNodeSelector": { - "description": "DefaultNodeSelector holds default project node label selector", + "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", + "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.", + "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.", + "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" } } @@ -17704,7 +17714,7 @@ ], "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", + "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", @@ -17712,7 +17722,7 @@ } }, "groupNameAttributes": { - "description": "GroupNameAttributes defines which attributes on an LDAP group entry will be interpreted as its name to use for an OpenShift group", + "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", @@ -17730,17 +17740,17 @@ "$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.", + "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.", + "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", + "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", @@ -17748,7 +17758,7 @@ } }, "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", + "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": "" }, @@ -17767,12 +17777,12 @@ ], "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.", + "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.", + "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" } } @@ -17788,22 +17798,22 @@ ], "properties": { "ca": { - "description": "CA is the CA for verifying TLS connections", + "description": "ca is the CA for verifying TLS connections", "type": "string", "default": "" }, "certFile": { - "description": "CertFile is a file containing a PEM-encoded certificate", + "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", + "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", + "description": "url is the remote URL to connect to", "type": "string", "default": "" } @@ -17821,12 +17831,12 @@ ], "properties": { "clientCA": { - "description": "ClientCA is a file with the trusted signer certs. It is required.", + "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.", + "description": "clientCommonNames is a required list of common names to require a match from.", "type": "array", "items": { "type": "string", @@ -17834,7 +17844,7 @@ } }, "extraHeaderPrefixes": { - "description": "ExtraHeaderPrefixes is the set of request header prefixes to inspect for user extra. X-Remote-Extra- is suggested.", + "description": "extraHeaderPrefixes is the set of request header prefixes to inspect for user extra. X-Remote-Extra- is suggested.", "type": "array", "items": { "type": "string", @@ -17850,7 +17860,7 @@ } }, "usernameHeaders": { - "description": "UsernameHeaders is the list of headers to check for user information. First hit wins.", + "description": "usernameHeaders is the list of headers to check for user information. First hit wins.", "type": "array", "items": { "type": "string", @@ -17878,17 +17888,17 @@ "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}", + "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.", + "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.", + "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", @@ -17896,7 +17906,7 @@ } }, "emailHeaders": { - "description": "EmailHeaders is the set of headers to check for the email address", + "description": "emailHeaders is the set of headers to check for the email address", "type": "array", "items": { "type": "string", @@ -17904,7 +17914,7 @@ } }, "headers": { - "description": "Headers is the set of headers to check for identity information", + "description": "headers is the set of headers to check for identity information", "type": "array", "items": { "type": "string", @@ -17916,12 +17926,12 @@ "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}", + "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", + "description": "nameHeaders is the set of headers to check for the display name", "type": "array", "items": { "type": "string", @@ -17929,7 +17939,7 @@ } }, "preferredUsernameHeaders": { - "description": "PreferredUsernameHeaders is the set of headers to check for the preferred username", + "description": "preferredUsernameHeaders is the set of headers to check for the preferred username", "type": "array", "items": { "type": "string", @@ -17946,7 +17956,7 @@ ], "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.", + "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": "" } @@ -17962,18 +17972,18 @@ ], "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", + "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).", + "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).", + "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": "" } @@ -17991,12 +18001,12 @@ ], "properties": { "limitSecretReferences": { - "description": "LimitSecretReferences controls whether or not to allow a service account to reference any secret in a namespace without explicitly referencing them", + "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.", + "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", @@ -18004,17 +18014,17 @@ } }, "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.", + "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.", + "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.", + "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", @@ -18031,7 +18041,7 @@ ], "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.", + "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" } } @@ -18049,22 +18059,22 @@ ], "properties": { "bindAddress": { - "description": "BindAddress is the ip:port to serve on", + "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\"", + "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", + "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", + "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", @@ -18072,21 +18082,21 @@ } }, "clientCA": { - "description": "ClientCA is the certificate bundle for all the signers that you'll recognize for incoming client certificates", + "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", + "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", + "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", + "description": "namedCertificates is a list of certificates to use to secure requests to specific hostnames", "type": "array", "items": { "default": {}, @@ -18105,18 +18115,18 @@ ], "properties": { "sessionMaxAgeSeconds": { - "description": "SessionMaxAgeSeconds specifies how long created sessions last. Used by AuthRequestHandlerSession", + "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", + "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", + "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": "" } @@ -18131,12 +18141,12 @@ ], "properties": { "authentication": { - "description": "Authentication is used to authenticate sessions using HMAC. Recommended to use a secret with 32 or 64 bytes.", + "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-", + "description": "encryption is used to encrypt sessions. Must be 16, 24, or 32 characters long, to select AES-128, AES-", "type": "string", "default": "" } @@ -18158,7 +18168,7 @@ "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.", + "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": {}, @@ -18188,22 +18198,22 @@ ], "properties": { "env": { - "description": "Env specifies an envvar containing the cleartext value, or an encrypted value if the keyFile is specified.", + "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.", + "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.", + "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.", + "description": "value specifies the cleartext value, or an encrypted value if keyFile is specified.", "type": "string", "default": "" } @@ -18220,22 +18230,22 @@ ], "properties": { "env": { - "description": "Env specifies an envvar containing the cleartext value, or an encrypted value if the keyFile is specified.", + "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.", + "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.", + "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.", + "description": "value specifies the cleartext value, or an encrypted value if keyFile is specified.", "type": "string", "default": "" } @@ -18250,18 +18260,18 @@ ], "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 overriden 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)", + "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 overriden 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", + "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", + "description": "authorizeTokenMaxAgeSeconds defines the maximum age of authorize tokens", "type": "integer", "format": "int32", "default": 0 @@ -18278,7 +18288,7 @@ ], "properties": { "httpVerbs": { - "description": "HTTPVerbs specifies which HTTP verbs should be matched. An empty list means \"match all verbs\".", + "description": "httpVerbs specifies which HTTP verbs should be matched. An empty list means \"match all verbs\".", "type": "array", "items": { "type": "string", @@ -18291,7 +18301,7 @@ "default": "" }, "rejectionMessage": { - "description": "RejectionMessage is the message shown when rejecting a client. If it is not a set, the default message is used.", + "description": "rejectionMessage is the message shown when rejecting a client. If it is not a set, the default message is used.", "type": "string", "default": "" } @@ -18306,7 +18316,7 @@ ], "properties": { "httpVerbs": { - "description": "HTTPVerbs specifies which HTTP verbs should be matched. An empty list means \"match all verbs\".", + "description": "httpVerbs specifies which HTTP verbs should be matched. An empty list means \"match all verbs\".", "type": "array", "items": { "type": "string", @@ -18330,7 +18340,7 @@ ], "properties": { "defaultRejectionMessage": { - "description": "DefaultRejectionMessage is the message shown when rejecting a client. If it is not a set, a generic message is given.", + "description": "defaultRejectionMessage is the message shown when rejecting a client. If it is not a set, a generic message is given.", "type": "string", "default": "" }, @@ -18361,12 +18371,12 @@ ], "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", + "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", + "description": "configFile is a path to a Kubeconfig file with the webhook configuration", "type": "string", "default": "" } @@ -18377,12 +18387,12 @@ "type": "object", "properties": { "placement": { - "description": "Placement configures the placement information for this instance.", + "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.", + "description": "subnet is a reference to the subnet to use for this instance.", "$ref": "#/definitions/com.github.openshift.api.machine.v1.AWSResourceReference" } } @@ -18395,7 +18405,7 @@ ], "properties": { "availabilityZone": { - "description": "AvailabilityZone is the availability zone of the instance.", + "description": "availabilityZone is the availability zone of the instance.", "type": "string", "default": "" } @@ -18409,7 +18419,7 @@ ], "properties": { "name": { - "description": "Name of the filter. Filter names are case-sensitive.", + "description": "name of the filter. Filter names are case-sensitive.", "type": "string", "default": "" }, @@ -18432,11 +18442,11 @@ ], "properties": { "arn": { - "description": "ARN of resource.", + "description": "arn of resource.", "type": "string" }, "filters": { - "description": "Filters is a set of filters used to identify a resource.", + "description": "filters is a set of filters used to identify a resource.", "type": "array", "items": { "default": {}, @@ -18445,11 +18455,11 @@ "x-kubernetes-list-type": "atomic" }, "id": { - "description": "ID of resource.", + "description": "id of resource.", "type": "string" }, "type": { - "description": "Type determines how the reference will fetch the AWS resource.", + "description": "type determines how the reference will fetch the AWS resource.", "type": "string", "default": "" } @@ -18483,12 +18493,12 @@ "type": "string" }, "bandwidth": { - "description": "Bandwidth describes the internet bandwidth strategy for the instance", + "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.", + "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": { @@ -18519,7 +18529,7 @@ "$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.", + "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": { @@ -18528,12 +18538,12 @@ "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.", + "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", + "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": {}, @@ -18541,7 +18551,7 @@ } }, "systemDisk": { - "description": "SystemDisk holds the properties regarding the system disk for the instance", + "description": "systemDisk holds the properties regarding the system disk for the instance", "default": {}, "$ref": "#/definitions/com.github.openshift.api.machine.v1.SystemDiskProperties" }, @@ -18554,15 +18564,15 @@ } }, "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`.", + "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", + "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.", + "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" }, @@ -18616,7 +18626,7 @@ "type": "string" }, "conditions": { - "description": "Conditions is a set of conditions associated with the Machine to indicate errors or other status", + "description": "conditions is a set of conditions associated with the Machine to indicate errors or other status", "type": "array", "items": { "default": {}, @@ -18624,11 +18634,11 @@ } }, "instanceId": { - "description": "InstanceID is the instance ID of the machine created in alibabacloud", + "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", + "description": "instanceState is the state of the alibabacloud instance for this machine", "type": "string" }, "kind": { @@ -18650,15 +18660,15 @@ ], "properties": { "id": { - "description": "ID of resource", + "description": "id of resource", "type": "string" }, "name": { - "description": "Name of the resource", + "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.", + "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": {}, @@ -18695,12 +18705,12 @@ "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.", + "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`", + "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" } @@ -18776,7 +18786,7 @@ "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.", + "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" }, @@ -18786,17 +18796,17 @@ "$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.", + "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.", + "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.", + "description": "template describes the Control Plane Machines that will be created by this ControlPlaneMachineSet.", "default": {}, "$ref": "#/definitions/com.github.openshift.api.machine.v1.ControlPlaneMachineSetTemplate" } @@ -18807,7 +18817,7 @@ "type": "object", "properties": { "conditions": { - "description": "Conditions represents the observations of the ControlPlaneMachineSet's current state. Known .status.conditions.type are: Available, Degraded and Progressing.", + "description": "conditions represents the observations of the ControlPlaneMachineSet's current state. Known .status.conditions.type are: Available, Degraded and Progressing.", "type": "array", "items": { "default": {}, @@ -18821,27 +18831,27 @@ "x-kubernetes-patch-strategy": "merge" }, "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.", + "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.", + "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.", + "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.", + "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.", + "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" } @@ -18852,7 +18862,7 @@ "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\".", + "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" } @@ -18861,9 +18871,12 @@ "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.", + "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" }, "machines_v1beta1_machine_openshift_io": { @@ -18888,7 +18901,7 @@ ], "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", + "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", @@ -18960,7 +18973,7 @@ ], "properties": { "aws": { - "description": "AWS configures failure domain information for the AWS platform.", + "description": "aws configures failure domain information for the AWS platform.", "type": "array", "items": { "default": {}, @@ -18969,7 +18982,7 @@ "x-kubernetes-list-type": "atomic" }, "azure": { - "description": "Azure configures failure domain information for the Azure platform.", + "description": "azure configures failure domain information for the Azure platform.", "type": "array", "items": { "default": {}, @@ -18978,7 +18991,7 @@ "x-kubernetes-list-type": "atomic" }, "gcp": { - "description": "GCP configures failure domain information for the GCP platform.", + "description": "gcp configures failure domain information for the GCP platform.", "type": "array", "items": { "default": {}, @@ -18999,7 +19012,7 @@ "x-kubernetes-list-type": "map" }, "openstack": { - "description": "OpenStack configures failure domain information for the OpenStack platform.", + "description": "openstack configures failure domain information for the OpenStack platform.", "type": "array", "items": { "default": {}, @@ -19008,7 +19021,7 @@ "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.", + "description": "platform identifies the platform for which the FailureDomain represents. Currently supported values are AWS, Azure, GCP, OpenStack, VSphere and Nutanix.", "type": "string", "default": "" }, @@ -19047,7 +19060,7 @@ ], "properties": { "zone": { - "description": "Zone is the zone in which the GCP machine provider will create the VM.", + "description": "zone is the zone in which the GCP machine provider will create the VM.", "type": "string", "default": "" } @@ -19296,7 +19309,7 @@ "type": "string" }, "type": { - "description": "Type is the identifier type to use for this resource.", + "description": "type is the identifier type to use for this resource.", "type": "string", "default": "" }, @@ -19370,7 +19383,9 @@ "description": "NutanixVMDiskDeviceProperties specifies the disk device properties.", "type": "object", "required": [ - "deviceType" + "deviceType", + "adapterType", + "deviceIndex" ], "properties": { "adapterType": { @@ -19416,7 +19431,7 @@ ], "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.", + "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": { @@ -19425,7 +19440,7 @@ "$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 overriden when the Machines are created based on the FailureDomains field.", + "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 overriden when the Machines are created based on the FailureDomains field.", "default": {}, "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.MachineSpec" } @@ -19567,19 +19582,19 @@ "type": "object", "properties": { "id": { - "description": "ID of resource", + "description": "id of resource", "type": "string" }, "name": { - "description": "Name of resource", + "description": "name of resource", "type": "string" }, "regex": { - "description": "Regex to find resource Regex contains the pattern to match to find a resource", + "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", + "description": "type identifies the resource type for this entry. Valid values are ID, Name and RegEx", "type": "string" } }, @@ -19599,7 +19614,7 @@ "type": "object", "properties": { "name": { - "description": "Name of the secret.", + "description": "name of the secret.", "type": "string" } }, @@ -19628,19 +19643,19 @@ "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`.", + "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 `\"\"`.", + "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.", + "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.", + "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" } @@ -19858,15 +19873,15 @@ "type": "string" }, "noAllowedAddressPairs": { - "description": "NoAllowedAddressPairs disables creation of allowed address pairs for the network ports", + "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", + "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", + "description": "portTags allows users to specify a list of tags to add to ports created in a given network", "type": "array", "items": { "type": "string", @@ -20338,11 +20353,11 @@ "$ref": "#/definitions/com.github.openshift.api.machine.v1alpha1.SubnetFilter" }, "portSecurity": { - "description": "PortSecurity optionally enables or disables security on ports managed by OpenStack", + "description": "portSecurity optionally enables or disables security on ports managed by OpenStack", "type": "boolean" }, "portTags": { - "description": "PortTags are tags that are added to ports created on this subnet", + "description": "portTags are tags that are added to ports created on this subnet", "type": "array", "items": { "type": "string", @@ -20367,7 +20382,7 @@ ], "properties": { "ami": { - "description": "AMI is the reference to the AMI from which to create the machine instance.", + "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" }, @@ -20376,7 +20391,7 @@ "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", + "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": {}, @@ -20389,26 +20404,26 @@ "default": "" }, "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.", + "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.", + "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 }, "iamInstanceProfile": { - "description": "IAMInstanceProfile is a reference to an IAM role to assign to the instance", + "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", + "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", + "description": "keyName is the name of the KeyPair to use for SSH", "type": "string" }, "kind": { @@ -20416,7 +20431,7 @@ "type": "string" }, "loadBalancers": { - "description": "LoadBalancers is the set of load balancers to which the new instance should be added once it is created.", + "description": "loadBalancers is the set of load balancers to which the new instance should be added once it is created.", "type": "array", "items": { "default": {}, @@ -20428,21 +20443,21 @@ "$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", + "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.", + "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", + "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.", + "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": { @@ -20451,11 +20466,11 @@ "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.", + "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.", + "description": "securityGroups is an array of references to security groups that should be applied to the instance.", "type": "array", "items": { "default": {}, @@ -20463,16 +20478,16 @@ } }, "spotMarketOptions": { - "description": "SpotMarketOptions allows users to configure instances to be run using AWS Spot instances.", + "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", + "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.", + "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": {}, @@ -20480,7 +20495,7 @@ } }, "userDataSecret": { - "description": "UserDataSecret contains a local reference to a secret that contains the UserData to apply to the instance", + "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" } } @@ -20522,7 +20537,7 @@ "type": "string" }, "conditions": { - "description": "Conditions is a set of conditions associated with the Machine to indicate errors or other status", + "description": "conditions is a set of conditions associated with the Machine to indicate errors or other status", "type": "array", "items": { "default": {}, @@ -20530,11 +20545,11 @@ } }, "instanceId": { - "description": "InstanceID is the instance ID of the machine created in AWS", + "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", + "description": "instanceState is the state of the AWS instance for this machine", "type": "string" }, "kind": { @@ -20548,11 +20563,11 @@ "type": "object", "properties": { "arn": { - "description": "ARN of resource", + "description": "arn of resource", "type": "string" }, "filters": { - "description": "Filters is a set of filters used to identify a resource", + "description": "filters is a set of filters used to identify a resource", "type": "array", "items": { "default": {}, @@ -20560,7 +20575,7 @@ } }, "id": { - "description": "ID of resource", + "description": "id of resource", "type": "string" } } @@ -20599,11 +20614,11 @@ ], "properties": { "customerManaged": { - "description": "CustomerManaged provides reference to the customer manager storage account.", + "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).", + "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": "" } @@ -20625,7 +20640,7 @@ ], "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.", + "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": "" } @@ -20652,7 +20667,7 @@ ], "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.", + "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": { @@ -20668,7 +20683,7 @@ } }, "availabilitySet": { - "description": "AvailabilitySet specifies the availability set to use for this instance. Availability set should be precreated, before using this field.", + "description": "availabilitySet specifies the availability set to use for this instance. Availability set should be precreated, before using this field.", "type": "string" }, "capacityReservationGroupID": { @@ -20676,7 +20691,7 @@ "type": "string" }, "credentialsSecret": { - "description": "CredentialsSecret is a reference to the secret with Azure credentials.", + "description": "credentialsSecret is a reference to the secret with Azure credentials.", "$ref": "#/definitions/io.k8s.api.core.v1.SecretReference" }, "dataDisks": { @@ -20688,12 +20703,12 @@ } }, "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.", + "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.", + "description": "image is the OS image to use to create the instance.", "default": {}, "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.Image" }, @@ -20706,11 +20721,11 @@ "type": "string" }, "location": { - "description": "Location is the region to use to create the instance", + "description": "location is the region to use to create the instance", "type": "string" }, "managedIdentity": { - "description": "ManagedIdentity to set managed identity name", + "description": "managedIdentity to set managed identity name", "type": "string" }, "metadata": { @@ -20718,30 +20733,30 @@ "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta" }, "natRule": { - "description": "NatRule to set inbound NAT rule of the load balancer", + "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", + "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.", + "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", + "description": "publicIP if true a public IP will be used", "type": "boolean", "default": false }, "publicLoadBalancer": { - "description": "PublicLoadBalancer to use for this instance", + "description": "publicLoadBalancer to use for this instance", "type": "string" }, "resourceGroup": { - "description": "ResourceGroup is the resource group for the virtual machine", + "description": "resourceGroup is the resource group for the virtual machine", "type": "string" }, "securityGroup": { @@ -20749,24 +20764,24 @@ "type": "string" }, "securityProfile": { - "description": "SecurityProfile specifies the Security profile settings for a virtual machine.", + "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", + "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.", + "description": "sshPublicKey is the public key to use to SSH to the virtual machine.", "type": "string" }, "subnet": { - "description": "Subnet to use for this instance", + "description": "subnet to use for this instance", "type": "string", "default": "" }, "tags": { - "description": "Tags is a list of tags to apply to the machine.", + "description": "tags is a list of tags to apply to the machine.", "type": "object", "additionalProperties": { "type": "string", @@ -20774,19 +20789,19 @@ } }, "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.", + "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", + "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.", + "description": "vmSize is the size of the VM to create.", "type": "string" }, "vnet": { - "description": "Vnet to set virtual network name", + "description": "vnet to set virtual network name", "type": "string" }, "zone": { @@ -20804,7 +20819,7 @@ "type": "string" }, "conditions": { - "description": "Conditions is a set of conditions associated with the Machine to indicate errors or other status.", + "description": "conditions is a set of conditions associated with the Machine to indicate errors or other status.", "type": "array", "items": { "default": {}, @@ -20820,11 +20835,11 @@ "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta" }, "vmId": { - "description": "VMID is the ID of the virtual machine created in Azure.", + "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.", + "description": "vmState is the provisioning state of the Azure virtual machine.", "type": "string" } } @@ -20873,16 +20888,16 @@ "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.", + "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.", + "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.", + "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": "" } @@ -20891,6 +20906,9 @@ "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.", @@ -20905,36 +20923,37 @@ "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.", + "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.", + "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.", + "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.", + "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" }, "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\".", + "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.", + "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": "" } @@ -21019,12 +21038,12 @@ ], "properties": { "name": { - "description": "Name of the filter. Filter names are case-sensitive.", + "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.", + "description": "values includes one or more filter values. Filter values are case-sensitive.", "type": "array", "items": { "type": "string", @@ -21046,26 +21065,26 @@ ], "properties": { "autoDelete": { - "description": "AutoDelete indicates if the disk will be auto-deleted when the instance is deleted (default false).", + "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).", + "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.", + "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.", + "description": "image is the source image to create this disk.", "type": "string", "default": "" }, "labels": { - "description": "Labels list of labels to apply to the disk.", + "description": "labels list of labels to apply to the disk.", "type": "object", "additionalProperties": { "type": "string", @@ -21073,13 +21092,13 @@ } }, "sizeGb": { - "description": "SizeGB is the size of the disk (in GB).", + "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).", + "description": "type is the type of the disk (eg: pd-standard).", "type": "string", "default": "" } @@ -21094,7 +21113,7 @@ "$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.", + "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" } } @@ -21108,13 +21127,13 @@ ], "properties": { "count": { - "description": "Count is the number of GPUs to be attached to an instance.", + "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", + "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": "" } @@ -21130,22 +21149,22 @@ ], "properties": { "keyRing": { - "description": "KeyRing is the name of the KMS Key Ring which the KMS Key belongs to.", + "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.", + "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.", + "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.", + "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" } } @@ -21167,7 +21186,7 @@ "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.", + "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 }, @@ -21176,16 +21195,16 @@ "type": "string" }, "credentialsSecret": { - "description": "CredentialsSecret is a reference to the secret with GCP credentials.", + "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.", + "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.", + "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" @@ -21199,7 +21218,7 @@ } }, "gpus": { - "description": "GPUs is a list of GPUs to be attached to the VM.", + "description": "gpus is a list of GPUs to be attached to the VM.", "type": "array", "items": { "default": {}, @@ -21211,7 +21230,7 @@ "type": "string" }, "labels": { - "description": "Labels list of labels to apply to the VM.", + "description": "labels list of labels to apply to the VM.", "type": "object", "additionalProperties": { "type": "string", @@ -21219,7 +21238,7 @@ } }, "machineType": { - "description": "MachineType is the machine type to use for the VM.", + "description": "machineType is the machine type to use for the VM.", "type": "string", "default": "" }, @@ -21229,26 +21248,26 @@ "$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.", + "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\".", + "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.", + "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.", + "description": "projectID is the project in which the GCP machine provider will create the VM.", "type": "string" }, "region": { - "description": "Region is the region in which the GCP machine provider will create the VM.", + "description": "region is the region in which the GCP machine provider will create the VM.", "type": "string", "default": "" }, @@ -21265,11 +21284,11 @@ "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", + "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.", + "description": "serviceAccounts is a list of GCP service accounts to be used by the VM.", "type": "array", "items": { "default": {}, @@ -21277,12 +21296,12 @@ } }, "shieldedInstanceConfig": { - "description": "ShieldedInstanceConfig is the Shielded VM configuration for the VM", + "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.", + "description": "tags list of network tags to apply to the VM.", "type": "array", "items": { "type": "string", @@ -21290,7 +21309,7 @@ } }, "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", + "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", @@ -21298,11 +21317,11 @@ } }, "userDataSecret": { - "description": "UserDataSecret contains a local reference to a secret that contains the UserData to apply to the instance", + "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.", + "description": "zone is the zone in which the GCP machine provider will create the VM.", "type": "string", "default": "" } @@ -21317,7 +21336,7 @@ "type": "string" }, "conditions": { - "description": "Conditions is a set of conditions associated with the Machine to indicate errors or other status", + "description": "conditions is a set of conditions associated with the Machine to indicate errors or other status", "type": "array", "items": { "default": {}, @@ -21325,11 +21344,11 @@ } }, "instanceId": { - "description": "InstanceID is the ID of the instance in GCP", + "description": "instanceId is the ID of the instance in GCP", "type": "string" }, "instanceState": { - "description": "InstanceState is the provisioning state of the GCP Instance.", + "description": "instanceState is the provisioning state of the GCP Instance.", "type": "string" }, "kind": { @@ -21351,12 +21370,12 @@ ], "properties": { "key": { - "description": "Key is the metadata key.", + "description": "key is the metadata key.", "type": "string", "default": "" }, "value": { - "description": "Value is the metadata value.", + "description": "value is the metadata value.", "type": "string" } } @@ -21366,19 +21385,19 @@ "type": "object", "properties": { "network": { - "description": "Network is the network name.", + "description": "network is the network name.", "type": "string" }, "projectID": { - "description": "ProjectID is the project in which the GCP machine provider will create the VM.", + "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", + "description": "publicIP indicates if true a public IP will be used", "type": "boolean" }, "subnetwork": { - "description": "Subnetwork is the subnetwork name.", + "description": "subnetwork is the subnetwork name.", "type": "string" } } @@ -21392,12 +21411,12 @@ ], "properties": { "email": { - "description": "Email is the service account email.", + "description": "email is the service account email.", "type": "string", "default": "" }, "scopes": { - "description": "Scopes list of scopes to be assigned to the service account.", + "description": "scopes list of scopes to be assigned to the service account.", "type": "array", "items": { "type": "string", @@ -21436,31 +21455,31 @@ ], "properties": { "offer": { - "description": "Offer specifies the name of a group of related images created by the publisher. For example, UbuntuServer, WindowsServer", + "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", + "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", + "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", + "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", + "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.", + "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": "" } @@ -21471,11 +21490,11 @@ "type": "object", "properties": { "description": { - "description": "Description is the human-readable description of the last operation.", + "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.", + "description": "lastUpdated is the timestamp at which LastOperation API was last-updated.", "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time" }, "state": { @@ -21497,12 +21516,12 @@ ], "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.", + "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.", + "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": "" } @@ -21513,7 +21532,7 @@ "type": "object", "properties": { "preDrain": { - "description": "PreDrain hooks prevent the machine from being drained. This also blocks further lifecycle events, such as termination.", + "description": "preDrain hooks prevent the machine from being drained. This also blocks further lifecycle events, such as termination.", "type": "array", "items": { "default": {}, @@ -21525,7 +21544,7 @@ "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.", + "description": "preTerminate hooks prevent the machine from being terminated. PreTerminate hooks be actioned after the Machine has been drained.", "type": "array", "items": { "default": {}, @@ -21658,7 +21677,7 @@ "$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.", + "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": { @@ -21667,7 +21686,7 @@ "$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.", + "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": {}, @@ -21685,7 +21704,7 @@ ], "properties": { "conditions": { - "description": "Conditions defines the current state of the MachineHealthCheck", + "description": "conditions defines the current state of the MachineHealthCheck", "type": "array", "items": { "default": {}, @@ -21707,7 +21726,7 @@ "format": "int32" }, "remediationsAllowed": { - "description": "RemediationsAllowed is the number of further remediations allowed by this machine health check before maxUnhealthy short circuiting will be applied", + "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 @@ -21812,26 +21831,26 @@ "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\"", + "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)", + "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.", + "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", + "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.", + "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" } @@ -21854,7 +21873,7 @@ "format": "int32" }, "conditions": { - "description": "Conditions defines the current state of the MachineSet", + "description": "conditions defines the current state of the MachineSet", "type": "array", "items": { "default": {}, @@ -21878,7 +21897,7 @@ "format": "int32" }, "observedGeneration": { - "description": "ObservedGeneration reflects the generation of the most recently observed MachineSet.", + "description": "observedGeneration reflects the generation of the most recently observed MachineSet.", "type": "integer", "format": "int64" }, @@ -21888,7 +21907,7 @@ "format": "int32" }, "replicas": { - "description": "Replicas is the most recently observed number of replicas.", + "description": "replicas is the most recently observed number of replicas.", "type": "integer", "format": "int32", "default": 0 @@ -21910,7 +21929,7 @@ "default": "MachineAPI" }, "lifecycleHooks": { - "description": "LifecycleHooks allow users to pause operations on the machine at certain predefined points within the machine lifecycle.", + "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" }, @@ -21920,11 +21939,11 @@ "$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.", + "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.", + "description": "providerSpec details Provider-specific configuration to use during node creation.", "default": {}, "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.ProviderSpec" }, @@ -21944,7 +21963,7 @@ "type": "object", "properties": { "addresses": { - "description": "Addresses is a list of addresses assigned to the machine. Queried from cloud provider, if available.", + "description": "addresses is a list of addresses assigned to the machine. Queried from cloud provider, if available.", "type": "array", "items": { "default": {}, @@ -21957,7 +21976,7 @@ "type": "string" }, "conditions": { - "description": "Conditions defines the current state of the Machine", + "description": "conditions defines the current state of the Machine", "type": "array", "items": { "default": {}, @@ -21969,31 +21988,31 @@ "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.", + "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.", + "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.", + "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.", + "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.", + "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", + "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.", + "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": { @@ -22024,7 +22043,7 @@ "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", + "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" } } @@ -22075,7 +22094,7 @@ ], "properties": { "devices": { - "description": "Devices defines the virtual machine's network interfaces.", + "description": "devices defines the virtual machine's network interfaces.", "type": "array", "items": { "default": {}, @@ -22093,27 +22112,27 @@ ], "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`.", + "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.", + "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.", + "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.", + "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\".", + "description": "osType is the operating system type of the OS disk. Possible values include \"Linux\" and \"Windows\".", "type": "string", "default": "" } @@ -22147,7 +22166,7 @@ "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", + "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", @@ -22155,7 +22174,7 @@ } }, "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", + "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": { @@ -22167,11 +22186,11 @@ } }, "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", + "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", + "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": { @@ -22195,15 +22214,15 @@ "type": "object", "properties": { "availabilityZone": { - "description": "AvailabilityZone is the availability zone of the instance", + "description": "availabilityZone is the availability zone of the instance", "type": "string" }, "region": { - "description": "Region is the region to use to create the instance", + "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.", + "description": "tenancy indicates if instance should run on shared or single-tenant hardware. There are supported 3 options: default, dedicated and host.", "type": "string" } } @@ -22213,7 +22232,7 @@ "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.", + "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" } } @@ -22262,6 +22281,9 @@ "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", @@ -22301,7 +22323,7 @@ "type": "object", "properties": { "maxPrice": { - "description": "MaxPrice defines the maximum price the user is willing to pay for Spot VM instances", + "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" } } @@ -22315,12 +22337,12 @@ ], "properties": { "name": { - "description": "Name of the tag", + "description": "name of the tag", "type": "string", "default": "" }, "value": { - "description": "Value of the tag", + "description": "value of the tag", "type": "string", "default": "" } @@ -22329,6 +22351,9 @@ "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.", @@ -22402,15 +22427,15 @@ "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.", + "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.", + "description": "credentialsSecret is a reference to the secret with vSphere credentials.", "$ref": "#/definitions/io.k8s.api.core.v1.LocalObjectReference" }, "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.", + "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" }, @@ -22419,7 +22444,7 @@ "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.", + "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" }, @@ -22428,12 +22453,12 @@ "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta" }, "network": { - "description": "Network is the network configuration for this machine's VM.", + "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.", + "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" }, @@ -22443,7 +22468,7 @@ "format": "int32" }, "snapshot": { - "description": "Snapshot is the name of the snapshot from which the VM was cloned", + "description": "snapshot is the name of the snapshot from which the VM was cloned", "type": "string", "default": "" }, @@ -22456,16 +22481,16 @@ } }, "template": { - "description": "Template is the name, inventory path, or instance UUID of the template used to clone new machines.", + "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", + "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.", + "description": "workspace describes the workspace to use for the machine.", "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.Workspace" } } @@ -22487,7 +22512,7 @@ } }, "instanceId": { - "description": "InstanceID is the ID of the instance in VSphere", + "description": "instanceId is the ID of the instance in VSphere", "type": "string" }, "instanceState": { @@ -22509,23 +22534,23 @@ "type": "object", "properties": { "datacenter": { - "description": "Datacenter is the datacenter in which VMs are created/located.", + "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.", + "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.", + "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.", + "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.", + "description": "server is the IP address or FQDN of the vSphere endpoint.", "type": "string" }, "vmGroup": { @@ -22766,6 +22791,7 @@ "description": "MachineConfigNodeStatus holds the reported information on a particular machine config node.", "type": "object", "required": [ + "observedGeneration", "configVersion" ], "properties": { @@ -23035,7 +23061,7 @@ "$ref": "#/definitions/com.github.openshift.api.machineconfiguration.v1alpha1.ObjectReference" }, "imageBuilderType": { - "description": "ImageBuilderType describes the image builder set in the MachineOSConfig", + "description": "imageBuilderType describes the image builder set in the MachineOSConfig", "type": "string", "default": "" } @@ -23150,6 +23176,9 @@ "com.github.openshift.api.machineconfiguration.v1alpha1.MachineOSConfigStatus": { "description": "MachineOSConfigStatus describes the status this config object and relates it to the builds associated with this MachineOSConfig", "type": "object", + "required": [ + "observedGeneration" + ], "properties": { "conditions": { "description": "conditions are state related conditions for the config.", @@ -23690,7 +23719,7 @@ "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.", + "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": {}, @@ -23698,7 +23727,7 @@ } }, "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", + "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" }, @@ -23712,25 +23741,25 @@ "$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.", + "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", + "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", + "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", + "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.", + "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" } @@ -23750,7 +23779,7 @@ "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.", + "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 @@ -23769,7 +23798,7 @@ "type": "string" }, "items": { - "description": "Items is the list of cluster networks", + "description": "items is the list of cluster networks", "type": "array", "items": { "default": {}, @@ -23849,11 +23878,11 @@ "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.", + "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", + "description": "dnsName is the domain name to allow/deny traffic to. If this is set, cidrSelector must be unset", "type": "string" } } @@ -23909,7 +23938,7 @@ "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.", + "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", @@ -23917,7 +23946,7 @@ } }, "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.", + "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", @@ -23925,12 +23954,12 @@ } }, "host": { - "description": "Host is the name of the node. (This is the same as the object's name, but both fields must be set.)", + "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", + "description": "hostIP is the IP address to be used as a VTEP by other nodes in the overlay network", "type": "string", "default": "" }, @@ -23944,7 +23973,7 @@ "$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", + "description": "subnet is the CIDR range of the overlay network assigned to the node for its pods", "type": "string", "default": "" } @@ -23962,7 +23991,7 @@ "type": "string" }, "items": { - "description": "Items is the list of host subnets", + "description": "items is the list of host subnets", "type": "array", "items": { "default": {}, @@ -23993,7 +24022,7 @@ "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.)", + "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", @@ -24010,13 +24039,13 @@ "$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.", + "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.)", + "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": "" } @@ -24034,7 +24063,7 @@ "type": "string" }, "items": { - "description": "Items is the list of net namespaces", + "description": "items is the list of net namespaces", "type": "array", "items": { "default": {}, @@ -24268,7 +24297,7 @@ } }, "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.", + "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": "" }, @@ -24278,7 +24307,7 @@ "$ref": "#/definitions/com.github.openshift.api.networkoperator.v1.EgressRouterInterface" }, "redirect": { - "description": "Redirect represents the configuration parameters specific to redirect mode.", + "description": "redirect represents the configuration parameters specific to redirect mode.", "$ref": "#/definitions/com.github.openshift.api.networkoperator.v1.RedirectConfig" } } @@ -24293,12 +24322,12 @@ ], "properties": { "allowEscalation": { - "description": "AllowEscalation indicates whether you can request roles and their escalating resources", + "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 *)", + "description": "namespaces is the list of namespaces that can be referenced. * means any of them (including *)", "type": "array", "items": { "type": "string", @@ -24306,7 +24335,7 @@ } }, "roleNames": { - "description": "RoleNames is the list of cluster roles that can referenced. * means anything", + "description": "roleNames is the list of cluster roles that can referenced. * means anything", "type": "array", "items": { "type": "string", @@ -24324,20 +24353,20 @@ "type": "string" }, "authorizeToken": { - "description": "AuthorizeToken contains the token that authorized this token", + "description": "authorizeToken contains the token that authorized this token", "type": "string" }, "clientName": { - "description": "ClientName references the client that created this token.", + "description": "clientName references the client that created this token.", "type": "string" }, "expiresIn": { - "description": "ExpiresIn is the seconds from CreationTime before this token expires.", + "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.", + "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" }, @@ -24351,15 +24380,15 @@ "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta" }, "redirectURI": { - "description": "RedirectURI is the redirection associated with the token.", + "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.", + "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.", + "description": "scopes is an array of the requested scopes.", "type": "array", "items": { "type": "string", @@ -24367,11 +24396,11 @@ } }, "userName": { - "description": "UserName is the user name associated with this token", + "description": "userName is the user name associated with this token", "type": "string" }, "userUID": { - "description": "UserUID is the unique UID associated with this token", + "description": "userUID is the unique UID associated with this token", "type": "string" } } @@ -24388,7 +24417,7 @@ "type": "string" }, "items": { - "description": "Items is the list of OAuth access tokens", + "description": "items is the list of OAuth access tokens", "type": "array", "items": { "default": {}, @@ -24415,19 +24444,19 @@ "type": "string" }, "clientName": { - "description": "ClientName references the client that created this token.", + "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", + "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", + "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.", + "description": "expiresIn is the seconds from CreationTime before this token expires.", "type": "integer", "format": "int64" }, @@ -24441,11 +24470,11 @@ "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta" }, "redirectURI": { - "description": "RedirectURI is the redirection associated with the token.", + "description": "redirectURI is the redirection associated with the token.", "type": "string" }, "scopes": { - "description": "Scopes is an array of the requested scopes.", + "description": "scopes is an array of the requested scopes.", "type": "array", "items": { "type": "string", @@ -24453,15 +24482,15 @@ } }, "state": { - "description": "State data from request", + "description": "state data from request", "type": "string" }, "userName": { - "description": "UserName is the user name associated with this token", + "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.", + "description": "userUID is the unique UID associated with this token. UserUID and UserName must both match for this token to be valid.", "type": "string" } } @@ -24478,7 +24507,7 @@ "type": "string" }, "items": { - "description": "Items is the list of OAuth authorization tokens", + "description": "items is the list of OAuth authorization tokens", "type": "array", "items": { "default": {}, @@ -24501,17 +24530,17 @@ "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", + "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.", + "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", + "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", @@ -24523,7 +24552,7 @@ "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", + "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": { @@ -24536,7 +24565,7 @@ "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta" }, "redirectURIs": { - "description": "RedirectURIs is the valid redirection URIs associated with a client", + "description": "redirectURIs is the valid redirection URIs associated with a client", "type": "array", "items": { "type": "string", @@ -24545,11 +24574,11 @@ "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", + "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.", + "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": {}, @@ -24557,7 +24586,7 @@ } }, "secret": { - "description": "Secret is the unique secret associated with a client", + "description": "secret is the unique secret associated with a client", "type": "string" } } @@ -24571,7 +24600,7 @@ "type": "string" }, "clientName": { - "description": "ClientName references the client that created this authorization", + "description": "clientName references the client that created this authorization", "type": "string" }, "kind": { @@ -24584,7 +24613,7 @@ "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta" }, "scopes": { - "description": "Scopes is an array of the granted scopes.", + "description": "scopes is an array of the granted scopes.", "type": "array", "items": { "type": "string", @@ -24592,11 +24621,11 @@ } }, "userName": { - "description": "UserName is the user name that authorized this client", + "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.", + "description": "userUID is the unique UID associated with this authorization. UserUID and UserName must both match for this authorization to be valid.", "type": "string" } } @@ -24613,7 +24642,7 @@ "type": "string" }, "items": { - "description": "Items is the list of OAuth client authorizations", + "description": "items is the list of OAuth client authorizations", "type": "array", "items": { "default": {}, @@ -24643,7 +24672,7 @@ "type": "string" }, "items": { - "description": "Items is the list of OAuth clients", + "description": "items is the list of OAuth clients", "type": "array", "items": { "default": {}, @@ -24716,7 +24745,7 @@ "type": "object", "properties": { "clusterRole": { - "description": "ClusterRole describes a set of restrictions for cluster role scoping.", + "description": "clusterRole describes a set of restrictions for cluster role scoping.", "$ref": "#/definitions/com.github.openshift.api.oauth.v1.ClusterRoleScopeRestriction" }, "literals": { @@ -24738,20 +24767,20 @@ "type": "string" }, "authorizeToken": { - "description": "AuthorizeToken contains the token that authorized this token", + "description": "authorizeToken contains the token that authorized this token", "type": "string" }, "clientName": { - "description": "ClientName references the client that created this token.", + "description": "clientName references the client that created this token.", "type": "string" }, "expiresIn": { - "description": "ExpiresIn is the seconds from CreationTime before this token expires.", + "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.", + "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" }, @@ -24765,15 +24794,15 @@ "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta" }, "redirectURI": { - "description": "RedirectURI is the redirection associated with the token.", + "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.", + "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.", + "description": "scopes is an array of the requested scopes.", "type": "array", "items": { "type": "string", @@ -24781,11 +24810,11 @@ } }, "userName": { - "description": "UserName is the user name associated with this token", + "description": "userName is the user name associated with this token", "type": "string" }, "userUID": { - "description": "UserUID is the unique UID associated with this token", + "description": "userUID is the unique UID associated with this token", "type": "string" } } @@ -24987,12 +25016,12 @@ ], "properties": { "cidr": { - "description": "CIDR defines the total range of a cluster networks address space.", + "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.", + "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 @@ -25091,12 +25120,12 @@ ], "properties": { "format": { - "description": "Format is the format of the name to be built for the system component", + "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", + "description": "latest determines if the latest tag will be pulled from the registry", "type": "boolean", "default": false } @@ -25545,12 +25574,12 @@ ], "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.", + "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.", + "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" } } @@ -25600,18 +25629,18 @@ ], "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", + "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).", + "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).", + "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": "" } @@ -25641,7 +25670,7 @@ ], "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.", + "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" } } @@ -25872,7 +25901,7 @@ "type": "string" }, "simpleMacvlanConfig": { - "description": "SimpleMacvlanConfig configures the macvlan interface in case of type:NetworkTypeSimpleMacvlan", + "description": "simpleMacvlanConfig configures the macvlan interface in case of type:NetworkTypeSimpleMacvlan", "$ref": "#/definitions/com.github.openshift.api.operator.v1.SimpleMacvlanConfig" }, "type": { @@ -26028,7 +26057,7 @@ "format": "int32" }, "oauthAPIServer": { - "description": "OAuthAPIServer holds status specific only to oauth-apiserver", + "description": "oauthAPIServer holds status specific only to oauth-apiserver", "default": {}, "$ref": "#/definitions/com.github.openshift.api.operator.v1.OAuthAPIServerStatus" }, @@ -26114,7 +26143,7 @@ "$ref": "#/definitions/com.github.openshift.api.operator.v1.IBMCloudCSIDriverConfigSpec" }, "vSphere": { - "description": "vsphere is used to configure the vsphere CSI driver.", + "description": "vSphere is used to configure the vsphere CSI driver.", "$ref": "#/definitions/com.github.openshift.api.operator.v1.VSphereCSIDriverConfigSpec" } }, @@ -26415,7 +26444,7 @@ ], "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\"", + "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": { @@ -26588,7 +26617,7 @@ "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.", + "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": { @@ -26716,7 +26745,7 @@ "type": "string" }, "items": { - "description": "Items contains the items", + "description": "items contains the items", "type": "array", "items": { "default": {}, @@ -27314,7 +27343,7 @@ ], "properties": { "openshiftSDNConfig": { - "description": "openShiftSDNConfig was previously used to configure the openshift-sdn plugin. DEPRECATED: OpenShift SDN is no longer supported.", + "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": { @@ -27337,7 +27366,7 @@ ], "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.", + "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": "" }, @@ -27373,7 +27402,7 @@ ], "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.", + "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": "" }, @@ -27414,6 +27443,9 @@ "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.", @@ -27545,7 +27577,7 @@ "type": "string" }, "items": { - "description": "Items contains the items", + "description": "items contains the items", "type": "array", "items": { "default": {}, @@ -27838,7 +27870,7 @@ "$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.", + "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" } } @@ -28020,7 +28052,7 @@ ], "properties": { "hybridClusterNetwork": { - "description": "HybridClusterNetwork defines a network space given to nodes on an additional overlay network.", + "description": "hybridClusterNetwork defines a network space given to nodes on an additional overlay network.", "type": "array", "items": { "default": {}, @@ -28029,7 +28061,7 @@ "x-kubernetes-list-type": "atomic" }, "hybridOverlayVXLANPort": { - "description": "HybridOverlayVXLANPort defines the VXLAN port number to be used by the additional overlay network. Default is 4789", + "description": "hybridOverlayVXLANPort defines the VXLAN port number to be used by the additional overlay network. Default is 4789", "type": "integer", "format": "int64" } @@ -28067,11 +28099,11 @@ ], "properties": { "staticIPAMConfig": { - "description": "StaticIPAMConfig configures the static IP address in case of type:IPAMTypeStatic", + "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", + "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": "" } @@ -28631,7 +28663,7 @@ "$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.", + "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": { @@ -28902,7 +28934,7 @@ "type": "string" }, "items": { - "description": "Items contains the items", + "description": "items contains the items", "type": "array", "items": { "default": {}, @@ -29090,7 +29122,7 @@ "type": "string" }, "items": { - "description": "Items contains the items", + "description": "items contains the items", "type": "array", "items": { "default": {}, @@ -29276,7 +29308,7 @@ "type": "string" }, "items": { - "description": "Items contains the items", + "description": "items contains the items", "type": "array", "items": { "default": {}, @@ -29454,7 +29486,7 @@ "type": "string" }, "items": { - "description": "Items contains the items", + "description": "items contains the items", "type": "array", "items": { "default": {}, @@ -29560,7 +29592,8 @@ "description": "LoadBalancerStrategy holds parameters for a load balancer.", "type": "object", "required": [ - "scope" + "scope", + "dnsManagementPolicy" ], "properties": { "allowedSourceRanges": { @@ -29698,7 +29731,7 @@ "type": "string" }, "items": { - "description": "Items contains the items", + "description": "items contains the items", "type": "array", "items": { "default": {}, @@ -30597,7 +30630,7 @@ "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.", + "description": "latestAvailableRevision is the latest revision used as suffix of revisioned secrets like encryption-config. A new revision causes a new deployment of pods.", "type": "integer", "format": "int32" } @@ -30649,7 +30682,7 @@ "type": "string" }, "items": { - "description": "Items contains the items", + "description": "items contains the items", "type": "array", "items": { "default": {}, @@ -30770,7 +30803,7 @@ "format": "int64" }, "hybridOverlayConfig": { - "description": "HybridOverlayConfig configures an additional overlay network for peers that are not using OVN.", + "description": "hybridOverlayConfig configures an additional overlay network for peers that are not using OVN.", "$ref": "#/definitions/com.github.openshift.api.operator.v1.HybridOverlayConfig" }, "ipsecConfig": { @@ -30857,7 +30890,7 @@ "type": "string" }, "items": { - "description": "Items contains the items", + "description": "items contains the items", "type": "array", "items": { "default": {}, @@ -31003,7 +31036,7 @@ "type": "string" }, "items": { - "description": "Items contains the items", + "description": "items contains the items", "type": "array", "items": { "default": {}, @@ -31266,6 +31299,9 @@ "com.github.openshift.api.operator.v1.PartialSelector": { "description": "PartialSelector provides label selector(s) that can be used to match machine management resources.", "type": "object", + "required": [ + "machineResourceSelector" + ], "properties": { "machineResourceSelector": { "description": "machineResourceSelector is a label selector that can be used to select machine resources like MachineSets.", @@ -31655,7 +31691,7 @@ "type": "string" }, "items": { - "description": "Items contains the items", + "description": "items contains the items", "type": "array", "items": { "default": {}, @@ -31800,7 +31836,7 @@ "type": "string" }, "items": { - "description": "Items contains the items", + "description": "items contains the items", "type": "array", "items": { "default": {}, @@ -31946,7 +31982,7 @@ "type": "string" }, "items": { - "description": "Items contains the items", + "description": "items contains the items", "type": "array", "items": { "default": {}, @@ -32053,7 +32089,7 @@ "type": "object", "properties": { "ipamConfig": { - "description": "IPAMConfig configures IPAM module will be used for IP Address Management (IPAM).", + "description": "ipamConfig configures IPAM module will be used for IP Address Management (IPAM).", "$ref": "#/definitions/com.github.openshift.api.operator.v1.IPAMConfig" }, "master": { @@ -32076,12 +32112,12 @@ "type": "object", "properties": { "address": { - "description": "Address is the IP address in CIDR format", + "description": "address is the IP address in CIDR format", "type": "string", "default": "" }, "gateway": { - "description": "Gateway is IP inside of subnet to designate as the gateway", + "description": "gateway is IP inside of subnet to designate as the gateway", "type": "string" } } @@ -32091,7 +32127,7 @@ "type": "object", "properties": { "addresses": { - "description": "Addresses configures IP address for the interface", + "description": "addresses configures IP address for the interface", "type": "array", "items": { "default": {}, @@ -32100,11 +32136,11 @@ "x-kubernetes-list-type": "atomic" }, "dns": { - "description": "DNS configures DNS for the interface", + "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", + "description": "routes configures IP routes for the interface", "type": "array", "items": { "default": {}, @@ -32119,11 +32155,11 @@ "type": "object", "properties": { "domain": { - "description": "Domain configures the domainname the local domain used for short hostname lookups", + "description": "domain configures the domainname the local domain used for short hostname lookups", "type": "string" }, "nameservers": { - "description": "Nameservers points DNS servers for IP lookup", + "description": "nameservers points DNS servers for IP lookup", "type": "array", "items": { "type": "string", @@ -32132,7 +32168,7 @@ "x-kubernetes-list-type": "atomic" }, "search": { - "description": "Search configures priority ordered search domains for short hostname lookups", + "description": "search configures priority ordered search domains for short hostname lookups", "type": "array", "items": { "type": "string", @@ -32150,12 +32186,12 @@ ], "properties": { "destination": { - "description": "Destination points the IP route destination", + "description": "destination points the IP route destination", "type": "string", "default": "" }, "gateway": { - "description": "Gateway is the route's next-hop IP address If unset, a default gateway is assumed (as determined by the CNI plugin).", + "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" } } @@ -32382,7 +32418,7 @@ "$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.", + "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": "" } @@ -32482,16 +32518,16 @@ ], "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.", + "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", + "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" }, "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", + "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", "type": "string", "default": "" } @@ -32502,7 +32538,7 @@ "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\"", + "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": { @@ -32516,7 +32552,7 @@ "$ref": "#/definitions/com.github.openshift.api.operator.v1.DNSTransportConfig" }, "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", + "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", "type": "array", "items": { "default": {}, @@ -32659,7 +32695,7 @@ "type": "object", "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.", + "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.", "type": "string", "default": "" } @@ -32667,9 +32703,6 @@ }, "com.github.openshift.api.operator.v1alpha1.EtcdBackupStatus": { "type": "object", - "required": [ - "backupJob" - ], "properties": { "backupJob": { "description": "backupJob is the reference to the Job that executes the backup. Optional", @@ -32758,7 +32791,7 @@ "$ref": "#/definitions/com.github.openshift.api.config.v1.LeaderElection" }, "servingInfo": { - "description": "ServingInfo is the HTTP serving information for the controller's endpoints", + "description": "servingInfo is the HTTP serving information for the controller's endpoints", "default": {}, "$ref": "#/definitions/com.github.openshift.api.config.v1.HTTPServingInfo" } @@ -32946,7 +32979,7 @@ "type": "string" }, "items": { - "description": "Items contains the items", + "description": "items contains the items", "type": "array", "items": { "default": {}, @@ -33277,19 +33310,19 @@ ], "properties": { "latency": { - "description": "Latency records how long the action mentioned in the entry took.", + "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.", + "description": "message explaining status in a human readable format.", "type": "string" }, "reason": { - "description": "Reason for status in a machine readable format.", + "description": "reason for status in a machine readable format.", "type": "string" }, "success": { - "description": "Success indicates if the log entry indicates a success or failure.", + "description": "success indicates if the log entry indicates a success or failure.", "type": "boolean", "default": false }, @@ -33307,11 +33340,11 @@ ], "properties": { "end": { - "description": "End of outage detected", + "description": "end of outage detected", "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time" }, "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.", + "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.", "type": "array", "items": { "default": {}, @@ -33323,11 +33356,11 @@ "type": "string" }, "start": { - "description": "Start of outage detected", + "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.", + "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": {}, @@ -33358,12 +33391,12 @@ "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta" }, "spec": { - "description": "Spec defines the source and target of the connectivity check", + "description": "spec defines the source and target of the connectivity check", "default": {}, "$ref": "#/definitions/com.github.openshift.api.operatorcontrolplane.v1alpha1.PodNetworkConnectivityCheckSpec" }, "status": { - "description": "Status contains the observed status of the connectivity check", + "description": "status contains the observed status of the connectivity check", "default": {}, "$ref": "#/definitions/com.github.openshift.api.operatorcontrolplane.v1alpha1.PodNetworkConnectivityCheckStatus" } @@ -33441,7 +33474,7 @@ ], "properties": { "sourcePod": { - "description": "SourcePod names the pod from which the condition will be checked", + "description": "sourcePod names the pod from which the condition will be checked", "type": "string", "default": "" }, @@ -33461,7 +33494,7 @@ "type": "object", "properties": { "conditions": { - "description": "Conditions summarize the status of the check", + "description": "conditions summarize the status of the check", "type": "array", "items": { "default": {}, @@ -33471,7 +33504,7 @@ "x-kubernetes-patch-strategy": "merge" }, "failures": { - "description": "Failures contains logs of unsuccessful check actions", + "description": "failures contains logs of unsuccessful check actions", "type": "array", "items": { "default": {}, @@ -33479,7 +33512,7 @@ } }, "outages": { - "description": "Outages contains logs of time periods of outages", + "description": "outages contains logs of time periods of outages", "type": "array", "items": { "default": {}, @@ -33487,7 +33520,7 @@ } }, "successes": { - "description": "Successes contains logs successful check actions", + "description": "successes contains logs successful check actions", "type": "array", "items": { "default": {}, @@ -33565,7 +33598,8 @@ "dnsName", "targets", "recordType", - "recordTTL" + "recordTTL", + "dnsManagementPolicy" ], "properties": { "dnsManagementPolicy": { @@ -33696,17 +33730,17 @@ "type": "string" }, "ca": { - "description": "CA is the CA for verifying TLS connections", + "description": "ca is the CA for verifying TLS connections", "type": "string", "default": "" }, "certFile": { - "description": "CertFile is a file containing a PEM-encoded certificate", + "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", + "description": "keyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile", "type": "string", "default": "" }, @@ -33715,7 +33749,7 @@ "type": "string" }, "url": { - "description": "URL is the remote URL to connect to", + "description": "url is the remote URL to connect to", "type": "string", "default": "" } @@ -33964,12 +33998,12 @@ "type": "string" }, "ca": { - "description": "CA is the CA for verifying TLS connections", + "description": "ca is the CA for verifying TLS connections", "type": "string", "default": "" }, "certFile": { - "description": "CertFile is a file containing a PEM-encoded certificate", + "description": "certFile is a file containing a PEM-encoded certificate", "type": "string", "default": "" }, @@ -33979,7 +34013,7 @@ "default": "" }, "keyFile": { - "description": "KeyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile", + "description": "keyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile", "type": "string", "default": "" }, @@ -33988,7 +34022,7 @@ "type": "string" }, "url": { - "description": "URL is the remote URL to connect to", + "description": "url is the remote URL to connect to", "type": "string", "default": "" }, @@ -34511,12 +34545,12 @@ ], "properties": { "authentication": { - "description": "Authentication is used to authenticate sessions using HMAC. Recommended to use a secret with 32 or 64 bytes.", + "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-", + "description": "encryption is used to encrypt sessions. Must be 16, 24, or 32 characters long, to select AES-128, AES-", "type": "string", "default": "" } @@ -34538,7 +34572,7 @@ "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.", + "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": {}, @@ -34716,12 +34750,12 @@ "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta" }, "spec": { - "description": "Spec defines the behavior of the Namespace.", + "description": "spec defines the behavior of the Namespace.", "default": {}, "$ref": "#/definitions/com.github.openshift.api.project.v1.ProjectSpec" }, "status": { - "description": "Status describes the current status of a Namespace", + "description": "status describes the current status of a Namespace", "default": {}, "$ref": "#/definitions/com.github.openshift.api.project.v1.ProjectStatus" } @@ -34739,7 +34773,7 @@ "type": "string" }, "items": { - "description": "Items is the list of projects", + "description": "items is the list of projects", "type": "array", "items": { "default": {}, @@ -34766,11 +34800,11 @@ "type": "string" }, "description": { - "description": "Description is the description to apply to a project", + "description": "description is the description to apply to a project", "type": "string" }, "displayName": { - "description": "DisplayName is the display name to apply to a project", + "description": "displayName is the display name to apply to a project", "type": "string" }, "kind": { @@ -34789,7 +34823,7 @@ "type": "object", "properties": { "finalizers": { - "description": "Finalizers is an opaque list of values that must be empty to permanently remove object from storage", + "description": "finalizers is an opaque list of values that must be empty to permanently remove object from storage", "type": "array", "items": { "type": "string", @@ -34813,7 +34847,7 @@ "x-kubernetes-patch-strategy": "merge" }, "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", + "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", "type": "string", "enum": [ "Active", @@ -34844,12 +34878,12 @@ "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta" }, "spec": { - "description": "Spec defines the desired quota", + "description": "spec defines the desired quota", "default": {}, "$ref": "#/definitions/com.github.openshift.api.quota.v1.ClusterResourceQuotaSpec" }, "status": { - "description": "Status defines the actual enforced quota and its current usage", + "description": "status defines the actual enforced quota and its current usage", "default": {}, "$ref": "#/definitions/com.github.openshift.api.quota.v1.ClusterResourceQuotaStatus" } @@ -34867,7 +34901,7 @@ "type": "string" }, "items": { - "description": "Items is a list of AppliedClusterResourceQuota", + "description": "items is a list of AppliedClusterResourceQuota", "type": "array", "items": { "default": {}, @@ -34907,12 +34941,12 @@ "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta" }, "spec": { - "description": "Spec defines the desired quota", + "description": "spec defines the desired quota", "default": {}, "$ref": "#/definitions/com.github.openshift.api.quota.v1.ClusterResourceQuotaSpec" }, "status": { - "description": "Status defines the actual enforced quota and its current usage", + "description": "status defines the actual enforced quota and its current usage", "default": {}, "$ref": "#/definitions/com.github.openshift.api.quota.v1.ClusterResourceQuotaStatus" } @@ -34930,7 +34964,7 @@ "type": "string" }, "items": { - "description": "Items is a list of ClusterResourceQuotas", + "description": "items is a list of ClusterResourceQuotas", "type": "array", "items": { "default": {}, @@ -34975,12 +35009,12 @@ ], "properties": { "quota": { - "description": "Quota defines the desired quota", + "description": "quota defines the desired quota", "default": {}, "$ref": "#/definitions/io.k8s.api.core.v1.ResourceQuotaSpec" }, "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.", + "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" } @@ -34994,7 +35028,7 @@ ], "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.", + "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.", "type": "array", "items": { "default": {}, @@ -35002,7 +35036,7 @@ } }, "total": { - "description": "Total defines the actual enforced quota and its current usage across all projects", + "description": "total defines the actual enforced quota and its current usage across all projects", "default": {}, "$ref": "#/definitions/io.k8s.api.core.v1.ResourceQuotaStatus" } @@ -35017,12 +35051,12 @@ ], "properties": { "namespace": { - "description": "Namespace the project this status applies to", + "description": "namespace the project this status applies to", "type": "string", "default": "" }, "status": { - "description": "Status indicates how many resources have been consumed by this project", + "description": "status indicates how many resources have been consumed by this project", "default": {}, "$ref": "#/definitions/io.k8s.api.core.v1.ResourceQuotaStatus" } @@ -35163,7 +35197,7 @@ "type": "object", "properties": { "conditions": { - "description": "Conditions is the state of the route, may be empty.", + "description": "conditions is the state of the route, may be empty.", "type": "array", "items": { "default": {}, @@ -35175,7 +35209,7 @@ "x-kubernetes-list-type": "map" }, "host": { - "description": "Host is the host string under which the route is exposed; this value is required", + "description": "host is the host string under which the route is exposed; this value is required", "type": "string" }, "routerCanonicalHostname": { @@ -35213,12 +35247,12 @@ "type": "string" }, "status": { - "description": "Status is the status of the condition. Can be True, False, Unknown.", + "description": "status is the status of the condition. Can be True, False, Unknown.", "type": "string", "default": "" }, "type": { - "description": "Type is the type of the condition. Currently only Admitted or UnservableInFutureVersions.", + "description": "type is the type of the condition. Currently only Admitted or UnservableInFutureVersions.", "type": "string", "default": "" } @@ -35650,7 +35684,7 @@ ], "properties": { "driver": { - "description": "Driver is the name of the Flexvolume driver.", + "description": "driver is the name of the Flexvolume driver.", "type": "string", "default": "" } @@ -35661,7 +35695,7 @@ "type": "object", "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.", + "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": {}, @@ -35670,7 +35704,7 @@ "x-kubernetes-list-type": "atomic" }, "type": { - "description": "Type is the strategy that will dictate what FSGroup is used in the SecurityContext.", + "description": "type is the strategy that will dictate what FSGroup is used in the SecurityContext.", "type": "string" } } @@ -35680,12 +35714,12 @@ "type": "object", "properties": { "max": { - "description": "Max is the end of the range, inclusive.", + "description": "max is the end of the range, inclusive.", "type": "integer", "format": "int64" }, "min": { - "description": "Min is the start of the range, inclusive.", + "description": "min is the start of the range, inclusive.", "type": "integer", "format": "int64" } @@ -35953,21 +35987,21 @@ "type": "object", "properties": { "type": { - "description": "Type is the strategy that will dictate what RunAsUser is used in the SecurityContext.", + "description": "type is the strategy that will dictate what RunAsUser is used in the SecurityContext.", "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.", + "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" }, "uidRangeMax": { - "description": "UIDRangeMax defines the max value for a strategy that allocates by range.", + "description": "uidRangeMax defines the max value for a strategy that allocates by range.", "type": "integer", "format": "int64" }, "uidRangeMin": { - "description": "UIDRangeMin defines the min value for a strategy that allocates by range.", + "description": "uidRangeMin defines the min value for a strategy that allocates by range.", "type": "integer", "format": "int64" } @@ -35982,7 +36016,7 @@ "$ref": "#/definitions/io.k8s.api.core.v1.SELinuxOptions" }, "type": { - "description": "Type is the strategy that will dictate what SELinux context is used in the SecurityContext.", + "description": "type is the strategy that will dictate what SELinux context is used in the SecurityContext.", "type": "string" } } @@ -36006,41 +36040,41 @@ ], "properties": { "allowHostDirVolumePlugin": { - "description": "AllowHostDirVolumePlugin determines if the policy allow containers to use the HostDir volume plugin", + "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.", + "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.", + "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.", + "description": "allowHostPID determines if the policy allows host pid in the containers.", "type": "boolean", "default": false }, "allowHostPorts": { - "description": "AllowHostPorts determines if the policy allows host ports in the containers.", + "description": "allowHostPorts determines if the policy allows host ports in the containers.", "type": "boolean", "default": false }, "allowPrivilegeEscalation": { - "description": "AllowPrivilegeEscalation determines if a pod can request to allow privilege escalation. If unspecified, defaults to true.", + "description": "allowPrivilegeEscalation determines if a pod can request to allow privilege escalation. If unspecified, defaults to true.", "type": "boolean" }, "allowPrivilegedContainer": { - "description": "AllowPrivilegedContainer determines if a container can request to be run as privileged.", + "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 '*'.", + "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 '*'.", "type": "array", "items": { "type": "string", @@ -36049,7 +36083,7 @@ "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.", + "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.", "type": "array", "items": { "default": {}, @@ -36058,7 +36092,7 @@ "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.", + "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.", "type": "array", "items": { "type": "string", @@ -36071,7 +36105,7 @@ "type": "string" }, "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.", + "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.", "type": "array", "items": { "type": "string", @@ -36080,11 +36114,11 @@ "x-kubernetes-list-type": "atomic" }, "defaultAllowPrivilegeEscalation": { - "description": "DefaultAllowPrivilegeEscalation controls the default setting for whether a process can gain more privileges than its parent process.", + "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.", + "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.", "type": "array", "items": { "type": "string", @@ -36093,7 +36127,7 @@ "x-kubernetes-list-type": "atomic" }, "fsGroup": { - "description": "FSGroup is the strategy that will dictate what fs group is used by the SecurityContext.", + "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" }, @@ -36116,17 +36150,17 @@ "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta" }, "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.", + "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" }, "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.", + "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 }, "requiredDropCapabilities": { - "description": "RequiredDropCapabilities are the capabilities that will be dropped from the container. These are required to be dropped and cannot be added.", + "description": "requiredDropCapabilities are the capabilities that will be dropped from the container. These are required to be dropped and cannot be added.", "type": "array", "items": { "type": "string", @@ -36135,17 +36169,17 @@ "x-kubernetes-list-type": "atomic" }, "runAsUser": { - "description": "RunAsUser is the strategy that will dictate what RunAsUser is used in the SecurityContext.", + "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.", + "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.", + "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.", "type": "array", "items": { "type": "string", @@ -36154,7 +36188,7 @@ "x-kubernetes-list-type": "atomic" }, "supplementalGroups": { - "description": "SupplementalGroups is the strategy that will dictate what supplemental groups are used by the SecurityContext.", + "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" }, @@ -36173,7 +36207,7 @@ "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\"].", + "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\"].", "type": "array", "items": { "type": "string", @@ -36245,7 +36279,7 @@ "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.", + "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": {}, @@ -36254,7 +36288,7 @@ "x-kubernetes-list-type": "atomic" }, "type": { - "description": "Type is the strategy that will dictate what supplemental groups is used in the SecurityContext.", + "description": "type is the strategy that will dictate what supplemental groups is used in the SecurityContext.", "type": "string" } } @@ -36366,7 +36400,7 @@ "type": "string" }, "items": { - "description": "Items contains the items", + "description": "items contains the items", "type": "array", "items": { "default": {}, @@ -36469,8 +36503,11 @@ } }, "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 volumes:\n - name: shared-configmap\n csi:\n driver: csi.sharedresource.openshift.io\n volumeAttributes:\n 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 `oc create role shared-resource-my-share --verb=use --resource=sharedconfigmaps.sharedresource.openshift.io --resource-name=my-share`\n `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.", + "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.", "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", @@ -36581,8 +36618,11 @@ } }, "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 volumes:\n - name: shared-secret\n csi:\n driver: csi.sharedresource.openshift.io\n volumeAttributes:\n 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 `oc create role shared-resource-my-share --verb=use --resource=sharedsecrets.sharedresource.openshift.io --resource-name=my-share`\n `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.", + "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.", "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", @@ -36758,7 +36798,7 @@ ], "properties": { "bindingIDs": { - "description": "bindingids is a list of 'binding_id's provided during successive bind calls to the template service broker.", + "description": "bindingIDs is a list of 'binding_id's provided during successive bind calls to the template service broker.", "type": "array", "items": { "type": "string", @@ -36771,7 +36811,7 @@ "$ref": "#/definitions/io.k8s.api.core.v1.ObjectReference" }, "templateInstance": { - "description": "templateinstance is a reference to a TemplateInstance object residing in a namespace.", + "description": "templateInstance is a reference to a TemplateInstance object residing in a namespace.", "default": {}, "$ref": "#/definitions/io.k8s.api.core.v1.ObjectReference" } @@ -36785,7 +36825,7 @@ ], "properties": { "description": { - "description": "Description of a parameter. Optional.", + "description": "description of a parameter. Optional.", "type": "string" }, "displayName": { @@ -36793,7 +36833,7 @@ "type": "string" }, "from": { - "description": "From is an input value for the generator. Optional.", + "description": "from is an input value for the generator. Optional.", "type": "string" }, "generate": { @@ -36801,7 +36841,7 @@ "type": "string" }, "name": { - "description": "Name must be set and it can be referenced in Template Items using ${PARAMETER_NAME}. Required.", + "description": "name must be set and it can be referenced in Template Items using ${PARAMETER_NAME}. Required.", "type": "string", "default": "" }, @@ -36810,7 +36850,7 @@ "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.", + "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" } } @@ -36908,26 +36948,26 @@ ], "properties": { "lastTransitionTime": { - "description": "LastTransitionTime is the last time a condition status transitioned from one state to another.", + "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.", + "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.", + "description": "reason is a brief machine readable explanation for the condition's last transition.", "type": "string", "default": "" }, "status": { - "description": "Status of the condition, one of True, False or Unknown.", + "description": "status of the condition, one of True, False or Unknown.", "type": "string", "default": "" }, "type": { - "description": "Type of the condition, currently Ready or InstantiateFailure.", + "description": "type of the condition, currently Ready or InstantiateFailure.", "type": "string", "default": "" } @@ -37042,7 +37082,7 @@ } }, "objects": { - "description": "Objects references the objects created by the TemplateInstance.", + "description": "objects references the objects created by the TemplateInstance.", "type": "array", "items": { "default": {}, @@ -37063,7 +37103,7 @@ "type": "string" }, "items": { - "description": "Items is a list of templates", + "description": "items is a list of templates", "type": "array", "items": { "default": {}, @@ -37102,7 +37142,7 @@ "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta" }, "users": { - "description": "Users is the list of users in this group.", + "description": "users is the list of users in this group.", "type": "array", "items": { "type": "string", @@ -37123,7 +37163,7 @@ "type": "string" }, "items": { - "description": "Items is the list of groups", + "description": "items is the list of groups", "type": "array", "items": { "default": {}, @@ -37155,7 +37195,7 @@ "type": "string" }, "extra": { - "description": "Extra holds extra information about this identity", + "description": "extra holds extra information about this identity", "type": "object", "additionalProperties": { "type": "string", @@ -37172,17 +37212,17 @@ "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta" }, "providerName": { - "description": "ProviderName is the source of identity information", + "description": "providerName is the source of identity information", "type": "string", "default": "" }, "providerUserName": { - "description": "ProviderUserName uniquely represents this identity in the scope of the provider", + "description": "providerUserName uniquely represents this identity in the scope of the provider", "type": "string", "default": "" }, "user": { - "description": "User is a reference to the user this identity is associated with Both Name and UID must be set", + "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" } @@ -37200,7 +37240,7 @@ "type": "string" }, "items": { - "description": "Items is the list of identities", + "description": "items is the list of identities", "type": "array", "items": { "default": {}, @@ -37230,11 +37270,11 @@ "type": "string" }, "fullName": { - "description": "FullName is the full name of user", + "description": "fullName is the full name of user", "type": "string" }, "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.", + "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", @@ -37242,7 +37282,7 @@ } }, "identities": { - "description": "Identities are the identities associated with this user", + "description": "identities are the identities associated with this user", "type": "array", "items": { "type": "string", @@ -37269,7 +37309,7 @@ "type": "string" }, "identity": { - "description": "Identity is a reference to an identity", + "description": "identity is a reference to an identity", "default": {}, "$ref": "#/definitions/io.k8s.api.core.v1.ObjectReference" }, @@ -37283,7 +37323,7 @@ "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta" }, "user": { - "description": "User is a reference to a user", + "description": "user is a reference to a user", "default": {}, "$ref": "#/definitions/io.k8s.api.core.v1.ObjectReference" } @@ -37301,7 +37341,7 @@ "type": "string" }, "items": { - "description": "Items is the list of users", + "description": "items is the list of users", "type": "array", "items": { "default": {}, diff --git a/openshiftcontrolplane/v1/types.go b/openshiftcontrolplane/v1/types.go index 33e3cf2912f..498f78df6d7 100644 --- a/openshiftcontrolplane/v1/types.go +++ b/openshiftcontrolplane/v1/types.go @@ -123,15 +123,15 @@ type RoutingConfig struct { type ImportModeType string const ( - // ImportModeLegacy 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. - ImportModeLegacy ImportModeType = "Legacy" - // ImportModePreserveOriginal indicates that the original manifest will be preserved. - // For manifest lists, the manifest list and all its sub-manifests will be imported. - ImportModePreserveOriginal ImportModeType = "PreserveOriginal" + // ImportModeLegacy 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. + ImportModeLegacy ImportModeType = "Legacy" + // ImportModePreserveOriginal indicates that the original manifest will be preserved. + // For manifest lists, the manifest list and all its sub-manifests will be imported. + ImportModePreserveOriginal ImportModeType = "PreserveOriginal" ) type ImagePolicyConfig struct { @@ -180,11 +180,11 @@ type AllowedRegistries []RegistryLocation // RegistryLocation contains a location of the registry specified by the registry domain // name. The domain name might include wildcards, like '*' or '??'. type RegistryLocation struct { - // DomainName specifies a domain name for the registry + // 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. DomainName string `json:"domainName"` - // Insecure indicates whether the registry is secure (https) or insecure (http) + // insecure indicates whether the registry is secure (https) or insecure (http) // By default (if not specified) the registry is assumed as secure. Insecure bool `json:"insecure,omitempty"` } @@ -440,36 +440,36 @@ type BuildOverridesConfig struct { // ImageConfig holds the necessary configuration options for building image names for system components type ImageConfig struct { - // Format is the format of the name to be built for the system component + // format is the format of the name to be built for the system component Format string `json:"format"` - // Latest determines if the latest tag will be pulled from the registry + // latest determines if the latest tag will be pulled from the registry Latest bool `json:"latest"` } // ServiceServingCert holds configuration for service serving cert signer which creates cert/key pairs for // pods fulfilling a service to serve with. type ServiceServingCert struct { - // Signer holds the signing information used to automatically sign serving certificates. + // signer holds the signing information used to automatically sign serving certificates. // If this value is nil, then certs are not signed automatically. Signer *configv1.CertInfo `json:"signer"` } // 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 ClusterNetworkEntry struct { - // CIDR defines the total range of a cluster networks address space. + // cidr defines the total range of a cluster networks address space. CIDR string `json:"cidr"` - // 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. + // 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. HostSubnetLength uint32 `json:"hostSubnetLength"` } // SecurityAllocator controls the automatic allocation of UIDs and MCS labels to a project. If nil, allocation is disabled. type SecurityAllocator struct { - // UIDAllocatorRange defines the total set of Unix user IDs (UIDs) that will be allocated to projects automatically, and the size of the + // 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). UIDAllocatorRange string `json:"uidAllocatorRange"` - // MCSAllocatorRange defines the range of MCS categories that will be assigned to namespaces. The format is + // 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 @@ -480,7 +480,7 @@ type SecurityAllocator struct { // * s0:/2,512 - Allocate labels from s0:c0,c0,c0 to s0:c511,c511,511 // MCSAllocatorRange string `json:"mcsAllocatorRange"` - // MCSLabelsPerProject defines the number of labels that should be reserved per project. The default is 5 to match the default UID and MCS + // 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). MCSLabelsPerProject int `json:"mcsLabelsPerProject"` } diff --git a/openshiftcontrolplane/v1/zz_generated.swagger_doc_generated.go b/openshiftcontrolplane/v1/zz_generated.swagger_doc_generated.go index 5162e46ba0c..0c73046ee16 100644 --- a/openshiftcontrolplane/v1/zz_generated.swagger_doc_generated.go +++ b/openshiftcontrolplane/v1/zz_generated.swagger_doc_generated.go @@ -59,8 +59,8 @@ func (BuildOverridesConfig) SwaggerDoc() map[string]string { var map_ClusterNetworkEntry = map[string]string{ "": "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.", - "cidr": "CIDR defines the total range of a cluster networks address space.", - "hostSubnetLength": "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.", + "cidr": "cidr defines the total range of a cluster networks address space.", + "hostSubnetLength": "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.", } func (ClusterNetworkEntry) SwaggerDoc() map[string]string { @@ -90,8 +90,8 @@ func (FrontProxyConfig) SwaggerDoc() map[string]string { var map_ImageConfig = map[string]string{ "": "ImageConfig holds the necessary configuration options for building image names for system components", - "format": "Format is the format of the name to be built for the system component", - "latest": "Latest determines if the latest tag will be pulled from the registry", + "format": "format is the format of the name to be built for the system component", + "latest": "latest determines if the latest tag will be pulled from the registry", } func (ImageConfig) SwaggerDoc() map[string]string { @@ -201,8 +201,8 @@ func (ProjectConfig) SwaggerDoc() map[string]string { var map_RegistryLocation = map[string]string{ "": "RegistryLocation contains a location of the registry specified by the registry domain name. The domain name might include wildcards, like '*' or '??'.", - "domainName": "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.", - "insecure": "Insecure indicates whether the registry is secure (https) or insecure (http) By default (if not specified) the registry is assumed as secure.", + "domainName": "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.", + "insecure": "insecure indicates whether the registry is secure (https) or insecure (http) By default (if not specified) the registry is assumed as secure.", } func (RegistryLocation) SwaggerDoc() map[string]string { @@ -220,9 +220,9 @@ func (RoutingConfig) SwaggerDoc() map[string]string { var map_SecurityAllocator = map[string]string{ "": "SecurityAllocator controls the automatic allocation of UIDs and MCS labels to a project. If nil, allocation is disabled.", - "uidAllocatorRange": "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).", - "mcsAllocatorRange": "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", - "mcsLabelsPerProject": "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).", + "uidAllocatorRange": "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).", + "mcsAllocatorRange": "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", + "mcsLabelsPerProject": "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).", } func (SecurityAllocator) SwaggerDoc() map[string]string { @@ -239,7 +239,7 @@ func (ServiceAccountControllerConfig) SwaggerDoc() map[string]string { var map_ServiceServingCert = map[string]string{ "": "ServiceServingCert holds configuration for service serving cert signer which creates cert/key pairs for pods fulfilling a service to serve with.", - "signer": "Signer holds the signing information used to automatically sign serving certificates. If this value is nil, then certs are not signed automatically.", + "signer": "signer holds the signing information used to automatically sign serving certificates. If this value is nil, then certs are not signed automatically.", } func (ServiceServingCert) SwaggerDoc() map[string]string { diff --git a/operator/v1/types.go b/operator/v1/types.go index f04b6846aee..b46448c8d68 100644 --- a/operator/v1/types.go +++ b/operator/v1/types.go @@ -16,7 +16,6 @@ type MyOperatorResource struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata"` - // +kubebuilder:validation:Required // +required Spec MyOperatorResourceSpec `json:"spec"` Status MyOperatorResourceStatus `json:"status"` @@ -145,19 +144,19 @@ type OperatorStatus struct { // GenerationStatus keeps track of the generation for a given resource so that decisions about forced updates can be made. type GenerationStatus struct { // group is the group of the thing you're tracking - // +kubebuilder:validation:Required + // +required Group string `json:"group"` // resource is the resource type of the thing you're tracking - // +kubebuilder:validation:Required + // +required Resource string `json:"resource"` // namespace is where the thing you're tracking is - // +kubebuilder:validation:Required + // +required Namespace string `json:"namespace"` // name is the name of the thing you're tracking - // +kubebuilder:validation:Required + // +required Name string `json:"name"` // TODO: Add validation for lastGeneration. The value for this field should generally increase, except when the associated @@ -194,21 +193,18 @@ type OperatorCondition struct { // useful (see .node.status.conditions), the ability to deconflict is important. // The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt) // +required - // +kubebuilder:validation:Required // +kubebuilder:validation:Pattern=`^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$` // +kubebuilder:validation:MaxLength=316 Type string `json:"type" protobuf:"bytes,1,opt,name=type"` // status of the condition, one of True, False, Unknown. // +required - // +kubebuilder:validation:Required // +kubebuilder:validation:Enum=True;False;Unknown Status ConditionStatus `json:"status"` // 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. // +required - // +kubebuilder:validation:Required // +kubebuilder:validation:Type=string // +kubebuilder:validation:Format=date-time LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty"` @@ -262,7 +258,7 @@ type StaticPodOperatorStatus struct { // NodeStatus provides information about the current state of a particular node managed by this operator. type NodeStatus struct { // nodeName is the name of the node - // +kubebuilder:validation:Required + // +required NodeName string `json:"nodeName"` // currentRevision is the generation of the most recently successful deployment diff --git a/operator/v1/types_authentication.go b/operator/v1/types_authentication.go index 58d8748d970..bf103f19bbb 100644 --- a/operator/v1/types_authentication.go +++ b/operator/v1/types_authentication.go @@ -25,7 +25,6 @@ type Authentication struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata,omitempty"` - // +kubebuilder:validation:Required // +required Spec AuthenticationSpec `json:"spec,omitempty"` // +optional @@ -37,7 +36,7 @@ type AuthenticationSpec struct { } type AuthenticationStatus struct { - // OAuthAPIServer holds status specific only to oauth-apiserver + // oauthAPIServer holds status specific only to oauth-apiserver // +optional OAuthAPIServer OAuthAPIServerStatus `json:"oauthAPIServer,omitempty"` @@ -45,7 +44,7 @@ type AuthenticationStatus struct { } type OAuthAPIServerStatus struct { - // LatestAvailableRevision is the latest revision used as suffix of revisioned + // latestAvailableRevision is the latest revision used as suffix of revisioned // secrets like encryption-config. A new revision causes a new deployment of pods. // +optional // +kubebuilder:validation:Minimum=0 diff --git a/operator/v1/types_cloudcredential.go b/operator/v1/types_cloudcredential.go index 9666b279222..b6ef52e9377 100644 --- a/operator/v1/types_cloudcredential.go +++ b/operator/v1/types_cloudcredential.go @@ -25,7 +25,6 @@ type CloudCredential struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata,omitempty"` - // +kubebuilder:validation:Required // +required Spec CloudCredentialSpec `json:"spec"` // +optional @@ -60,7 +59,7 @@ const ( // CloudCredentialSpec is the specification of the desired behavior of the cloud-credential-operator. type CloudCredentialSpec struct { OperatorSpec `json:",inline"` - // CredentialsMode allows informing CCO that it should not attempt to dynamically + // 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. diff --git a/operator/v1/types_config.go b/operator/v1/types_config.go index e7c6d59dbb2..f0d190e6db3 100644 --- a/operator/v1/types_config.go +++ b/operator/v1/types_config.go @@ -26,7 +26,6 @@ type Config struct { metav1.ObjectMeta `json:"metadata"` // spec is the specification of the desired behavior of the Config Operator. - // +kubebuilder:validation:Required // +required Spec ConfigSpec `json:"spec"` @@ -56,6 +55,6 @@ type ConfigList struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ListMeta `json:"metadata"` - // Items contains the items + // items contains the items Items []Config `json:"items"` } diff --git a/operator/v1/types_console.go b/operator/v1/types_console.go index aa39b2f950f..68d9daa4501 100644 --- a/operator/v1/types_console.go +++ b/operator/v1/types_console.go @@ -26,7 +26,6 @@ type Console struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata,omitempty"` - // +kubebuilder:validation:Required // +required Spec ConsoleSpec `json:"spec,omitempty"` // +optional @@ -128,7 +127,7 @@ type CapabilityVisibility struct { // Disabling the capability in the console UI is represented by the "Disabled" value. // +unionDiscriminator // +kubebuilder:validation:Enum:="Enabled";"Disabled" - // +kubebuilder:validation:Required + // +required State CapabilityState `json:"state"` } @@ -137,10 +136,10 @@ type Capability struct { // name is the unique name of a capability. // Available capabilities are LightspeedButton and GettingStartedBanner. // +kubebuilder:validation:Enum:="LightspeedButton";"GettingStartedBanner" - // +kubebuilder:validation:Required + // +required Name ConsoleCapabilityName `json:"name"` // visibility defines the visibility state of the capability. - // +kubebuilder:validation:Required + // +required Visibility CapabilityVisibility `json:"visibility"` } @@ -184,21 +183,17 @@ type ConsoleCustomization struct { // +optional CustomLogoFile configv1.ConfigMapFileReference `json:"customLogoFile,omitempty"` // developerCatalog allows to configure the shown developer catalog categories (filters) and types (sub-catalogs). - // +kubebuilder:validation:Optional // +optional DeveloperCatalog DeveloperConsoleCatalogCustomization `json:"developerCatalog,omitempty"` // 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. - // +kubebuilder:validation:Optional // +optional ProjectAccess ProjectAccess `json:"projectAccess,omitempty"` // quickStarts allows customization of available ConsoleQuickStart resources in console. - // +kubebuilder:validation:Optional // +optional QuickStarts QuickStarts `json:"quickStarts,omitempty"` // addPage allows customizing actions on the Add page in developer perspective. - // +kubebuilder:validation:Optional // +optional AddPage AddPage `json:"addPage,omitempty"` // perspectives allows enabling/disabling of perspective(s) that user can see in the Perspective switcher dropdown. @@ -212,7 +207,6 @@ type ConsoleCustomization struct { type ProjectAccess struct { // availableClusterRoles is the list of ClusterRole names that are assignable to users // through the project access tab. - // +kubebuilder:validation:Optional // +optional AvailableClusterRoles []string `json:"availableClusterRoles,omitempty"` } @@ -235,7 +229,7 @@ type DeveloperConsoleCatalogTypes struct { // +kubebuilder:validation:Enum:="Enabled";"Disabled"; // +kubebuilder:default:="Enabled" // +default="Enabled" - // +kubebuilder:validation:Required + // +required State CatalogTypesState `json:"state,omitempty"` // 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 @@ -259,7 +253,6 @@ type DeveloperConsoleCatalogTypes struct { // DeveloperConsoleCatalogCustomization allow cluster admin to configure developer catalog. type DeveloperConsoleCatalogCustomization struct { // categories which are shown in the developer catalog. - // +kubebuilder:validation:Optional // +optional Categories []DeveloperConsoleCatalogCategory `json:"categories,omitempty"` // types allows enabling or disabling of sub-catalog types that user can see in the Developer catalog. @@ -270,23 +263,20 @@ type DeveloperConsoleCatalogCustomization struct { // DeveloperConsoleCatalogCategoryMeta are the key identifiers of a developer catalog category. type DeveloperConsoleCatalogCategoryMeta struct { - // ID is an identifier used in the URL to enable deep linking in console. + // 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. - // +kubebuilder:validation:Required // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=32 // +kubebuilder:validation:Pattern=`^[A-Za-z0-9-_]+$` // +required ID string `json:"id"` // label defines a category display label. It is required and must have 1-64 characters. - // +kubebuilder:validation:Required // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=64 // +required Label string `json:"label"` // 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. - // +kubebuilder:validation:Optional // +optional Tags []string `json:"tags,omitempty"` } @@ -296,7 +286,6 @@ type DeveloperConsoleCatalogCategory struct { // defines top level category ID, label and filter tags. DeveloperConsoleCatalogCategoryMeta `json:",inline"` // subcategories defines a list of child categories. - // +kubebuilder:validation:Optional // +optional Subcategories []DeveloperConsoleCatalogCategoryMeta `json:"subcategories,omitempty"` } @@ -304,7 +293,6 @@ type DeveloperConsoleCatalogCategory struct { // QuickStarts allow cluster admins to customize available ConsoleQuickStart resources. type QuickStarts struct { // disabled is a list of ConsoleQuickStart resource names that are not shown to users. - // +kubebuilder:validation:Optional // +optional Disabled []string `json:"disabled,omitempty"` } @@ -313,7 +301,6 @@ type QuickStarts struct { type AddPage struct { // disabledActions is a list of actions that are not shown to users. // Each action in the list is represented by its ID. - // +kubebuilder:validation:Optional // +kubebuilder:validation:MinItems=1 // +optional DisabledActions []string `json:"disabledActions,omitempty"` @@ -350,7 +337,7 @@ type PerspectiveVisibility struct { // state defines the perspective is enabled or disabled or access review check is required. // +unionDiscriminator // +kubebuilder:validation:Enum:="Enabled";"Disabled";"AccessReview" - // +kubebuilder:validation:Required + // +required State PerspectiveState `json:"state"` // accessReview defines required and missing access review checks. // +optional @@ -365,10 +352,10 @@ type Perspective struct { // 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. - // +kubebuilder:validation:Required + // +required ID string `json:"id"` // visibility defines the state of perspective along with access review checks if needed for that perspective. - // +kubebuilder:validation:Required + // +required Visibility PerspectiveVisibility `json:"visibility"` // 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`. @@ -386,20 +373,20 @@ type PinnedResourceReference struct { // This value should consist of only lowercase alphanumeric characters, hyphens and periods. // Example: "", "apps", "build.openshift.io", etc. // +kubebuilder:validation:Pattern:="^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$" - // +kubebuilder:validation:Required + // +required Group string `json:"group"` // version is the API Version of the Resource. // This value should consist of only lowercase alphanumeric characters. // Example: "v1", "v1beta1", etc. // +kubebuilder:validation:Pattern:="^[a-z0-9]+$" - // +kubebuilder:validation:Required + // +required Version string `json:"version"` // 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. // +kubebuilder:validation:Pattern:="^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" - // +kubebuilder:validation:Required + // +required Resource string `json:"resource"` } diff --git a/operator/v1/types_csi_cluster_driver.go b/operator/v1/types_csi_cluster_driver.go index fa81ea7d79f..731323750a4 100644 --- a/operator/v1/types_csi_cluster_driver.go +++ b/operator/v1/types_csi_cluster_driver.go @@ -36,7 +36,6 @@ type ClusterCSIDriver struct { metav1.ObjectMeta `json:"metadata,omitempty"` // spec holds user settable values for configuration - // +kubebuilder:validation:Required // +required Spec ClusterCSIDriverSpec `json:"spec"` @@ -95,7 +94,7 @@ const ( // ClusterCSIDriverSpec is the desired behavior of CSI driver operator type ClusterCSIDriverSpec struct { OperatorSpec `json:",inline"` - // StorageClassState determines if CSI operator should create and manage storage classes. + // 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 @@ -135,7 +134,7 @@ type CSIDriverConfigSpec struct { // driverConfig is being applied to. // Valid values are: AWS, Azure, GCP, IBMCloud, vSphere and omitted. // Consumers should treat unknown values as a NO-OP. - // +kubebuilder:validation:Required + // +required // +unionDiscriminator DriverType CSIDriverType `json:"driverType"` @@ -155,7 +154,7 @@ type CSIDriverConfigSpec struct { // +optional IBMCloud *IBMCloudCSIDriverConfigSpec `json:"ibmcloud,omitempty"` - // vsphere is used to configure the vsphere CSI driver. + // vSphere is used to configure the vsphere CSI driver. // +optional VSphere *VSphereCSIDriverConfigSpec `json:"vSphere,omitempty"` } @@ -198,7 +197,7 @@ type AWSEFSVolumeMetrics struct { // 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. // +unionDiscriminator - // +kubebuilder:validation:Required + // +required State AWSEFSVolumeMetricsState `json:"state"` // recursiveWalk provides additional configuration for collecting volume metrics in the AWS EFS CSI Driver @@ -240,7 +239,7 @@ type AzureDiskEncryptionSet struct { // 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 - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:MaxLength:=36 // +kubebuilder:validation:Pattern:=`^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$` SubscriptionID string `json:"subscriptionID"` @@ -250,7 +249,7 @@ type AzureDiskEncryptionSet struct { // underscores (_), parentheses, hyphens and periods. // The value should not end in a period and be at most 90 characters in // length. - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:MaxLength:=90 // +kubebuilder:validation:Pattern:=`^[\w\.\-\(\)]*[\w\-\(\)]$` ResourceGroup string `json:"resourceGroup"` @@ -258,7 +257,7 @@ type AzureDiskEncryptionSet struct { // 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. - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:MaxLength:=80 // +kubebuilder:validation:Pattern:=`^[a-zA-Z0-9\_-]+$` Name string `json:"name"` @@ -281,7 +280,7 @@ type GCPKMSKeyReference struct { // +kubebuilder:validation:Pattern:=`^[a-zA-Z0-9\_-]+$` // +kubebuilder:validation:MinLength:=1 // +kubebuilder:validation:MaxLength:=63 - // +kubebuilder:validation:Required + // +required Name string `json:"name"` // keyRing is the name of the KMS Key Ring which the KMS Key belongs to. @@ -291,7 +290,7 @@ type GCPKMSKeyReference struct { // +kubebuilder:validation:Pattern:=`^[a-zA-Z0-9\_-]+$` // +kubebuilder:validation:MinLength:=1 // +kubebuilder:validation:MaxLength:=63 - // +kubebuilder:validation:Required + // +required KeyRing string `json:"keyRing"` // projectID is the ID of the Project in which the KMS Key Ring exists. @@ -300,7 +299,7 @@ type GCPKMSKeyReference struct { // +kubebuilder:validation:Pattern:=`^[a-z][a-z0-9-]+[a-z0-9]$` // +kubebuilder:validation:MinLength:=6 // +kubebuilder:validation:MaxLength:=30 - // +kubebuilder:validation:Required + // +required ProjectID string `json:"projectID"` // location is the GCP location in which the Key Ring exists. @@ -323,7 +322,7 @@ type GCPCSIDriverConfigSpec struct { type IBMCloudCSIDriverConfigSpec struct { // encryptionKeyCRN is the IBM Cloud CRN of the customer-managed root key to use // for disk encryption of volumes for the default storage classes. - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:MaxLength:=154 // +kubebuilder:validation:MinLength:=144 // +kubebuilder:validation:Pattern:=`^crn:v[0-9]+:bluemix:(public|private):(kms|hs-crypto):[a-z-]+:a/[0-9a-f]+:[0-9a-f-]{36}:key:[0-9a-f-]{36}$` diff --git a/operator/v1/types_csi_snapshot.go b/operator/v1/types_csi_snapshot.go index f96384819c4..d6d283d3652 100644 --- a/operator/v1/types_csi_snapshot.go +++ b/operator/v1/types_csi_snapshot.go @@ -25,7 +25,6 @@ type CSISnapshotController struct { metav1.ObjectMeta `json:"metadata,omitempty"` // spec holds user settable values for configuration - // +kubebuilder:validation:Required // +required Spec CSISnapshotControllerSpec `json:"spec"` diff --git a/operator/v1/types_dns.go b/operator/v1/types_dns.go index 3d7cbb6c00a..25880478684 100644 --- a/operator/v1/types_dns.go +++ b/operator/v1/types_dns.go @@ -226,7 +226,7 @@ type DNSOverTLSConfig struct { // // + --- // + Inspired by the DNS1123 patterns in Kubernetes: https://github.com/kubernetes/kubernetes/blob/7c46f40bdf89a437ecdbc01df45e235b5f6d9745/staging/src/k8s.io/apimachinery/pkg/util/validation/validation.go#L178-L218 - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:MaxLength=253 // +kubebuilder:validation:Pattern=`^([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]{0,61}[a-zA-Z0-9])(\.([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]{0,61}[a-zA-Z0-9]))*$` ServerName string `json:"serverName"` @@ -319,7 +319,7 @@ type ForwardPlugin struct { // * At least one upstream should be specified. // * the default policy is Sequential type UpstreamResolvers struct { - // Upstreams is a list of resolvers to forward name queries for the "." domain. + // 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. @@ -332,7 +332,7 @@ type UpstreamResolvers struct { // +kubebuilder:default={{"type":"SystemResolvConf"}} Upstreams []Upstream `json:"upstreams"` - // Policy is used to determine the order in which upstream servers are selected for querying. + // policy is used to determine the order in which upstream servers are selected for querying. // Any one of the following values may be specified: // // * "Random" picks a random upstream server for each query. @@ -381,31 +381,28 @@ type UpstreamResolvers struct { // with an IP address or IP:port if the upstream listens on a port other than 53. type Upstream struct { - // Type defines whether this upstream contains an IP/IP:port resolver or the local /etc/resolv.conf. + // 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. // // * When SystemResolvConf is used, the Upstream structure does not require any further fields to be defined: // /etc/resolv.conf will be used // * When Network is used, the Upstream structure must contain at least an Address // - // +kubebuilder:validation:Required // +required Type UpstreamType `json:"type"` - // Address must be defined when Type is set to Network. It will be ignored otherwise. + // address must be defined when Type is set to Network. It will be ignored otherwise. // It must be a valid ipv4 or ipv6 address. // // +optional - // +kubebuilder:validation:Optional Address string `json:"address,omitempty"` - // Port may be defined when Type is set to Network. It will be ignored otherwise. + // port may be defined when Type is set to Network. It will be ignored otherwise. // Port must be between 65535 // // +optional // +kubebuilder:validation:Minimum=1 // +kubebuilder:validation:Maximum=65535 - // +kubebuilder:validation:Optional // +kubebuilder:default=53 Port uint32 `json:"port,omitempty"` } @@ -483,7 +480,6 @@ type DNSStatus struct { // // More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies // - // +kubebuilder:validation:Required // +required ClusterIP string `json:"clusterIP"` @@ -494,7 +490,6 @@ type DNSStatus struct { // // More info: https://kubernetes.io/docs/concepts/services-networking/dns-pod-service // - // +kubebuilder:validation:Required // +required ClusterDomain string `json:"clusterDomain"` diff --git a/operator/v1/types_etcd.go b/operator/v1/types_etcd.go index 71345d7d786..375ec5fb7fd 100644 --- a/operator/v1/types_etcd.go +++ b/operator/v1/types_etcd.go @@ -24,7 +24,6 @@ type Etcd struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata"` - // +kubebuilder:validation:Required // +required Spec EtcdSpec `json:"spec"` // +optional @@ -39,7 +38,6 @@ type EtcdSpec struct { // Valid values are "", "Standard" and "Slower". // "" means no opinion and the platform is left to choose a reasonable default // which is subject to change without notice. - // +kubebuilder:validation:Optional // +openshift:enable:FeatureGate=HardwareSpeed // +optional HardwareSpeed ControlPlaneHardwareSpeed `json:"controlPlaneHardwareSpeed"` @@ -93,6 +91,6 @@ type EtcdList struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ListMeta `json:"metadata"` - // Items contains the items + // items contains the items Items []Etcd `json:"items"` } diff --git a/operator/v1/types_ingress.go b/operator/v1/types_ingress.go index 1f566434564..6304c956361 100644 --- a/operator/v1/types_ingress.go +++ b/operator/v1/types_ingress.go @@ -397,7 +397,6 @@ type LoadBalancerStrategy struct { // scope indicates the scope at which the load balancer is exposed. // Possible values are "External" and "Internal". // - // +kubebuilder:validation:Required // +required Scope LoadBalancerScope `json:"scope"` @@ -434,7 +433,7 @@ type LoadBalancerStrategy struct { // Valid values are: Managed and Unmanaged. // // +kubebuilder:default:="Managed" - // +kubebuilder:validation:Required + // +required // +default="Managed" DNSManagementPolicy LoadBalancerDNSManagementPolicy `json:"dnsManagementPolicy,omitempty"` } @@ -464,7 +463,6 @@ type ProviderLoadBalancerParameters struct { // "OpenStack", and "VSphere". // // +unionDiscriminator - // +kubebuilder:validation:Required // +required Type LoadBalancerProviderType `json:"type"` @@ -544,7 +542,6 @@ type AWSLoadBalancerParameters struct { // https://docs.aws.amazon.com/AmazonECS/latest/developerguide/load-balancer-types.html#nlb // // +unionDiscriminator - // +kubebuilder:validation:Required // +required Type AWSLoadBalancerType `json:"type"` @@ -713,7 +710,6 @@ type AWSClassicLoadBalancerParameters struct { // 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. // - // +kubebuilder:validation:Optional // +kubebuilder:validation:Format=duration // +optional ConnectionIdleTimeout metav1.Duration `json:"connectionIdleTimeout,omitempty"` @@ -828,7 +824,6 @@ type HostNetworkStrategy struct { // The empty string specifies the default, which is TCP without PROXY // protocol. Note that the default is subject to change. // - // +kubebuilder:validation:Optional // +optional Protocol IngressControllerProtocol `json:"protocol,omitempty"` @@ -836,7 +831,6 @@ type HostNetworkStrategy struct { // 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. - // +kubebuilder:validation:Optional // +kubebuilder:validation:Maximum=65535 // +kubebuilder:validation:Minimum=0 // +kubebuilder:default=80 @@ -847,7 +841,6 @@ type HostNetworkStrategy struct { // 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. - // +kubebuilder:validation:Optional // +kubebuilder:validation:Maximum=65535 // +kubebuilder:validation:Minimum=0 // +kubebuilder:default=443 @@ -868,7 +861,6 @@ type HostNetworkStrategy struct { // 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. - // +kubebuilder:validation:Optional // +kubebuilder:validation:Maximum=65535 // +kubebuilder:validation:Minimum=0 // +kubebuilder:default=1936 @@ -904,7 +896,6 @@ type PrivateStrategy struct { // The empty string specifies the default, which is TCP without PROXY // protocol. Note that the default is subject to change. // - // +kubebuilder:validation:Optional // +optional Protocol IngressControllerProtocol `json:"protocol,omitempty"` } @@ -936,7 +927,6 @@ type NodePortStrategy struct { // The empty string specifies the default, which is TCP without PROXY // protocol. Note that the default is subject to change. // - // +kubebuilder:validation:Optional // +optional Protocol IngressControllerProtocol `json:"protocol,omitempty"` } @@ -1004,7 +994,6 @@ type EndpointPublishingStrategy struct { // field of the managed NodePort Service will preserved. // // +unionDiscriminator - // +kubebuilder:validation:Required // +required Type EndpointPublishingStrategyType `json:"type"` @@ -1054,7 +1043,6 @@ type ClientTLS struct { // edge-terminated and reencrypt TLS routes; it cannot check // certificates for cleartext HTTP or passthrough TLS routes. // - // +kubebuilder:validation:Required // +required ClientCertificatePolicy ClientCertificatePolicy `json:"clientCertificatePolicy"` @@ -1063,7 +1051,6 @@ type ClientTLS struct { // certificate. The administrator must create this configmap in the // openshift-config namespace. // - // +kubebuilder:validation:Required // +required ClientCA configv1.ConfigMapNameReference `json:"clientCA"` @@ -1167,14 +1154,12 @@ type SyslogLoggingDestinationParameters struct { // address is the IP address of the syslog endpoint that receives log // messages. // - // +kubebuilder:validation:Required // +required Address string `json:"address"` // port is the UDP port number of the syslog endpoint that receives log // messages. // - // +kubebuilder:validation:Required // +kubebuilder:validation:Minimum=1 // +kubebuilder:validation:Maximum=65535 // +required @@ -1184,7 +1169,6 @@ type SyslogLoggingDestinationParameters struct { // // If this field is empty, the facility is "local1". // - // +kubebuilder:validation:Optional // +kubebuilder:validation:Enum=kern;user;mail;daemon;auth;syslog;lpr;news;uucp;cron;auth2;ftp;ntp;audit;alert;cron2;local0;local1;local2;local3;local4;local5;local6;local7 // +optional Facility string `json:"facility,omitempty"` @@ -1244,7 +1228,6 @@ type LoggingDestination struct { // that the administrator has configured a custom syslog instance. // // +unionDiscriminator - // +kubebuilder:validation:Required // +required Type LoggingDestinationType `json:"type"` @@ -1267,7 +1250,6 @@ type IngressControllerCaptureHTTPHeader struct { // name specifies a header name. Its value must be a valid HTTP header // name as defined in RFC 2616 section 4.2. // - // +kubebuilder:validation:Required // +kubebuilder:validation:Pattern="^[-!#$%&'*+.0-9A-Z^_`a-z|~]+$" // +required Name string `json:"name"` @@ -1277,7 +1259,6 @@ type IngressControllerCaptureHTTPHeader struct { // log message. Note that the ingress controller may impose a separate // bound on the total length of HTTP headers in a request. // - // +kubebuilder:validation:Required // +kubebuilder:validation:Minimum=1 // +required MaxLength int `json:"maxLength"` @@ -1331,7 +1312,6 @@ type IngressControllerCaptureHTTPCookie struct { // controller may impose a separate bound on the total length of HTTP // headers in a request. // - // +kubebuilder:validation:Required // +kubebuilder:validation:Minimum=1 // +kubebuilder:validation:Maximum=1024 // +required @@ -1351,7 +1331,6 @@ type IngressControllerCaptureHTTPCookieUnion struct { // matching cookie is captured. // // +unionDiscriminator - // +kubebuilder:validation:Required // +required MatchType CookieMatchType `json:"matchType,omitempty"` @@ -1389,7 +1368,6 @@ const ( type AccessLogging struct { // destination is where access logs go. // - // +kubebuilder:validation:Required // +required Destination LoggingDestination `json:"destination"` @@ -1646,7 +1624,7 @@ type IngressControllerHTTPHeader struct { // Strict-Transport-Security, Proxy, Host, Cookie, Set-Cookie. // It must be no more than 255 characters in length. // Header name must be unique. - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=255 // +kubebuilder:validation:Pattern="^[-!#$%&'*+.0-9A-Z^_`a-z|~]+$" @@ -1657,7 +1635,7 @@ type IngressControllerHTTPHeader struct { // +kubebuilder:validation:XValidation:rule="self.lowerAscii() != 'set-cookie'",message="set-cookie header may not be modified via header actions" Name string `json:"name"` // action specifies actions to perform on headers, such as setting or deleting headers. - // +kubebuilder:validation:Required + // +required Action IngressControllerHTTPHeaderActionUnion `json:"action"` } @@ -1671,7 +1649,7 @@ type IngressControllerHTTPHeaderActionUnion struct { // Delete allows you to delete HTTP request and response headers. // +unionDiscriminator // +kubebuilder:validation:Enum:=Set;Delete - // +kubebuilder:validation:Required + // +required Type IngressControllerHTTPHeaderActionType `json:"type"` // set specifies how the HTTP header should be set. @@ -1704,7 +1682,7 @@ type IngressControllerSetHTTPHeader struct { // + --- // + Note: This limit was selected as most common web servers have a limit of 16384 characters or some lower limit. // + See . - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=16384 Value string `json:"value"` @@ -1725,7 +1703,6 @@ type IngressControllerTuningOptions struct { // headerBufferBytes values that are too large could cause the // IngressController to use significantly more memory than necessary. // - // +kubebuilder:validation:Optional // +kubebuilder:validation:Minimum=16384 // +optional HeaderBufferBytes int32 `json:"headerBufferBytes,omitempty"` @@ -1745,7 +1722,6 @@ type IngressControllerTuningOptions struct { // large could cause the IngressController to use significantly more memory // than necessary. // - // +kubebuilder:validation:Optional // +kubebuilder:validation:Minimum=4096 // +optional HeaderBufferMaxRewriteBytes int32 `json:"headerBufferMaxRewriteBytes,omitempty"` @@ -1763,7 +1739,6 @@ type IngressControllerTuningOptions struct { // Reducing the number of threads may cause the ingress controller to // perform poorly. // - // +kubebuilder:validation:Optional // +kubebuilder:validation:Minimum=1 // +kubebuilder:validation:Maximum=64 // +optional @@ -1773,7 +1748,6 @@ type IngressControllerTuningOptions struct { // waiting for a client response. // // If unset, the default timeout is 30s - // +kubebuilder:validation:Optional // +kubebuilder:validation:Format=duration // +optional ClientTimeout *metav1.Duration `json:"clientTimeout,omitempty"` @@ -1783,7 +1757,6 @@ type IngressControllerTuningOptions struct { // connection. // // If unset, the default timeout is 1s - // +kubebuilder:validation:Optional // +kubebuilder:validation:Format=duration // +optional ClientFinTimeout *metav1.Duration `json:"clientFinTimeout,omitempty"` @@ -1792,7 +1765,6 @@ type IngressControllerTuningOptions struct { // waiting for a server/backend response. // // If unset, the default timeout is 30s - // +kubebuilder:validation:Optional // +kubebuilder:validation:Format=duration // +optional ServerTimeout *metav1.Duration `json:"serverTimeout,omitempty"` @@ -1802,7 +1774,6 @@ type IngressControllerTuningOptions struct { // connection. // // If unset, the default timeout is 1s - // +kubebuilder:validation:Optional // +kubebuilder:validation:Format=duration // +optional ServerFinTimeout *metav1.Duration `json:"serverFinTimeout,omitempty"` @@ -1811,12 +1782,11 @@ type IngressControllerTuningOptions struct { // websockets) will be held open while the tunnel is idle. // // If unset, the default timeout is 1h - // +kubebuilder:validation:Optional // +kubebuilder:validation:Format=duration // +optional TunnelTimeout *metav1.Duration `json:"tunnelTimeout,omitempty"` - // ConnectTimeout defines the maximum time to wait for + // connectTimeout defines the maximum time to wait for // a connection attempt to a server/backend to succeed. // // This field expects an unsigned duration string of decimal numbers, each with optional @@ -1827,7 +1797,6 @@ type IngressControllerTuningOptions struct { // to choose a reasonable default. This default is subject to change over time. // The current default is 5s. // - // +kubebuilder:validation:Optional // +kubebuilder:validation:Pattern=^(0|([0-9]+(\.[0-9]+)?(ns|us|µs|μs|ms|s|m|h))+)$ // +kubebuilder:validation:Type:=string // +optional @@ -1841,7 +1810,6 @@ type IngressControllerTuningOptions struct { // matching certificate could be used. // // If unset, the default inspect delay is 5s - // +kubebuilder:validation:Optional // +kubebuilder:validation:Format=duration // +optional TLSInspectDelay *metav1.Duration `json:"tlsInspectDelay,omitempty"` @@ -1867,7 +1835,6 @@ type IngressControllerTuningOptions struct { // Currently the minimum allowed value is 1s and the maximum allowed value is // 2147483647ms (24.85 days). Both are subject to change over time. // - // +kubebuilder:validation:Optional // +kubebuilder:validation:Pattern=^(0|([0-9]+(\.[0-9]+)?(ns|us|µs|μs|ms|s|m|h))+)$ // +kubebuilder:validation:Type:=string // +optional @@ -1914,7 +1881,6 @@ type IngressControllerTuningOptions struct { // 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"}'. // - // +kubebuilder:validation:Optional // +optional MaxConnections int32 `json:"maxConnections,omitempty"` @@ -1945,7 +1911,6 @@ type IngressControllerTuningOptions struct { // be reloaded less frequently, and newly created routes will not be served until the // subsequent reload. // - // +kubebuilder:validation:Optional // +kubebuilder:validation:Pattern=^(0|([0-9]+(\.[0-9]+)?(ns|us|µs|μs|ms|s|m|h))+)$ // +kubebuilder:validation:Type:=string // +optional diff --git a/operator/v1/types_insights.go b/operator/v1/types_insights.go index 56e2b51c14c..00eb360804b 100644 --- a/operator/v1/types_insights.go +++ b/operator/v1/types_insights.go @@ -25,7 +25,7 @@ type InsightsOperator struct { metav1.ObjectMeta `json:"metadata"` // spec is the specification of the desired behavior of the Insights. - // +kubebuilder:validation:Required + // +required Spec InsightsOperatorSpec `json:"spec"` // status is the most recently observed status of the Insights operator. @@ -85,25 +85,25 @@ type InsightsReport struct { // healthCheck represents an Insights health check attributes. type HealthCheck struct { // description provides basic description of the healtcheck. - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:MaxLength=2048 // +kubebuilder:validation:MinLength=10 Description string `json:"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. - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:Minimum=1 // +kubebuilder:validation:Maximum=4 TotalRisk int32 `json:"totalRisk"` // advisorURI provides the URL link to the Insights Advisor. - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:Pattern=`^https:\/\/\S+` AdvisorURI string `json:"advisorURI"` // 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. - // +kubebuilder:validation:Required + // +required State HealthCheckState `json:"state"` } @@ -124,16 +124,16 @@ const ( type GathererStatus struct { // conditions provide details on the status of each gatherer. // +listType=atomic - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:MinItems=1 Conditions []metav1.Condition `json:"conditions"` // name is the name of the gatherer. - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:MaxLength=256 // +kubebuilder:validation:MinLength=5 Name string `json:"name"` // lastGatherDuration represents the time spent gathering. - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:Type=string // +kubebuilder:validation:Pattern="^([1-9][0-9]*(\\.[0-9]+)?(ns|us|µs|ms|s|m|h))+$" LastGatherDuration metav1.Duration `json:"lastGatherDuration"` diff --git a/operator/v1/types_kubeapiserver.go b/operator/v1/types_kubeapiserver.go index 5c9d43a2a21..ce00b4b62cf 100644 --- a/operator/v1/types_kubeapiserver.go +++ b/operator/v1/types_kubeapiserver.go @@ -26,7 +26,6 @@ type KubeAPIServer struct { metav1.ObjectMeta `json:"metadata"` // spec is the specification of the desired behavior of the Kubernetes API Server - // +kubebuilder:validation:Required // +required Spec KubeAPIServerSpec `json:"spec"` @@ -78,6 +77,6 @@ type KubeAPIServerList struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ListMeta `json:"metadata"` - // Items contains the items + // items contains the items Items []KubeAPIServer `json:"items"` } diff --git a/operator/v1/types_kubecontrollermanager.go b/operator/v1/types_kubecontrollermanager.go index 93ab209a0d5..ee104aa5065 100644 --- a/operator/v1/types_kubecontrollermanager.go +++ b/operator/v1/types_kubecontrollermanager.go @@ -25,7 +25,6 @@ type KubeControllerManager struct { metav1.ObjectMeta `json:"metadata"` // spec is the specification of the desired behavior of the Kubernetes Controller Manager - // +kubebuilder:validation:Required // +required Spec KubeControllerManagerSpec `json:"spec"` @@ -63,6 +62,6 @@ type KubeControllerManagerList struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ListMeta `json:"metadata"` - // Items contains the items + // items contains the items Items []KubeControllerManager `json:"items"` } diff --git a/operator/v1/types_kubestorageversionmigrator.go b/operator/v1/types_kubestorageversionmigrator.go index 470dc5097da..f3add49101c 100644 --- a/operator/v1/types_kubestorageversionmigrator.go +++ b/operator/v1/types_kubestorageversionmigrator.go @@ -24,7 +24,6 @@ type KubeStorageVersionMigrator struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata"` - // +kubebuilder:validation:Required // +required Spec KubeStorageVersionMigratorSpec `json:"spec"` // +optional @@ -52,6 +51,6 @@ type KubeStorageVersionMigratorList struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ListMeta `json:"metadata"` - // Items contains the items + // items contains the items Items []KubeStorageVersionMigrator `json:"items"` } diff --git a/operator/v1/types_machineconfiguration.go b/operator/v1/types_machineconfiguration.go index 8bd41eb69d7..88b89f81884 100644 --- a/operator/v1/types_machineconfiguration.go +++ b/operator/v1/types_machineconfiguration.go @@ -25,7 +25,7 @@ type MachineConfiguration struct { metav1.ObjectMeta `json:"metadata"` // spec is the specification of the desired behavior of the Machine Config Operator - // +kubebuilder:validation:Required + // +required Spec MachineConfigurationSpec `json:"spec"` // status is the most recently observed status of the Machine Config Operator @@ -111,7 +111,7 @@ type MachineConfigurationList struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ListMeta `json:"metadata"` - // Items contains the items + // items contains the items Items []MachineConfiguration `json:"items"` } @@ -131,17 +131,17 @@ type MachineManager struct { // resource is the machine management resource's type. // The only current valid value is machinesets. // machinesets means that the machine manager will only register resources of the kind MachineSet. - // +kubebuilder:validation:Required + // +required Resource MachineManagerMachineSetsResourceType `json:"resource"` // 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. - // +kubebuilder:validation:Required + // +required APIGroup MachineManagerMachineSetsAPIGroupType `json:"apiGroup"` // selection allows granular control of the machine management resources that will be registered for boot image updates. - // +kubebuilder:validation:Required + // +required Selection MachineManagerSelector `json:"selection"` } @@ -153,7 +153,7 @@ type MachineManagerSelector struct { // 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. // +unionDiscriminator - // +kubebuilder:validation:Required + // +required Mode MachineManagerSelectorMode `json:"mode"` // partial provides label selector(s) that can be used to match machine management resources. @@ -165,7 +165,7 @@ type MachineManagerSelector struct { // PartialSelector provides label selector(s) that can be used to match machine management resources. type PartialSelector struct { // machineResourceSelector is a label selector that can be used to select machine resources like MachineSets. - // +kubebuilder:validation:Required + // +required MachineResourceSelector *metav1.LabelSelector `json:"machineResourceSelector,omitempty"` } @@ -255,7 +255,7 @@ type NodeDisruptionPolicyClusterStatus struct { type NodeDisruptionPolicySpecFile struct { // 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. - // +kubebuilder:validation:Required + // +required Path string `json:"path"` // 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 @@ -264,7 +264,7 @@ type NodeDisruptionPolicySpecFile struct { // 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. - // +kubebuilder:validation:Required + // +required // +listType=atomic // +kubebuilder:validation:MaxItems=10 // +kubebuilder:validation:XValidation:rule="self.exists(x, x.type=='Reboot') ? size(self) == 1 : true", message="Reboot action can only be specified standalone, as it will override any other actions" @@ -276,7 +276,7 @@ type NodeDisruptionPolicySpecFile struct { type NodeDisruptionPolicyStatusFile struct { // 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. - // +kubebuilder:validation:Required + // +required Path string `json:"path"` // 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 @@ -285,7 +285,7 @@ type NodeDisruptionPolicyStatusFile struct { // 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. - // +kubebuilder:validation:Required + // +required // +listType=atomic // +kubebuilder:validation:MaxItems=10 // +kubebuilder:validation:XValidation:rule="self.exists(x, x.type=='Reboot') ? size(self) == 1 : true", message="Reboot action can only be specified standalone, as it will override any other actions" @@ -300,7 +300,7 @@ type NodeDisruptionPolicySpecUnit struct { // 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". - // +kubebuilder:validation:Required + // +required Name NodeDisruptionPolicyServiceName `json:"name"` // actions represents the series of commands to be executed on changes to the file at @@ -310,7 +310,7 @@ type NodeDisruptionPolicySpecUnit struct { // 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. - // +kubebuilder:validation:Required + // +required // +listType=atomic // +kubebuilder:validation:MaxItems=10 // +kubebuilder:validation:XValidation:rule="self.exists(x, x.type=='Reboot') ? size(self) == 1 : true", message="Reboot action can only be specified standalone, as it will override any other actions" @@ -325,7 +325,7 @@ type NodeDisruptionPolicyStatusUnit struct { // 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". - // +kubebuilder:validation:Required + // +required Name NodeDisruptionPolicyServiceName `json:"name"` // actions represents the series of commands to be executed on changes to the file at @@ -335,7 +335,7 @@ type NodeDisruptionPolicyStatusUnit struct { // 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. - // +kubebuilder:validation:Required + // +required // +listType=atomic // +kubebuilder:validation:MaxItems=10 // +kubebuilder:validation:XValidation:rule="self.exists(x, x.type=='Reboot') ? size(self) == 1 : true", message="Reboot action can only be specified standalone, as it will override any other actions" @@ -352,7 +352,7 @@ type NodeDisruptionPolicySpecSSHKey struct { // 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. - // +kubebuilder:validation:Required + // +required // +listType=atomic // +kubebuilder:validation:MaxItems=10 // +kubebuilder:validation:XValidation:rule="self.exists(x, x.type=='Reboot') ? size(self) == 1 : true", message="Reboot action can only be specified standalone, as it will override any other actions" @@ -369,7 +369,7 @@ type NodeDisruptionPolicyStatusSSHKey struct { // 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. - // +kubebuilder:validation:Required + // +required // +listType=atomic // +kubebuilder:validation:MaxItems=10 // +kubebuilder:validation:XValidation:rule="self.exists(x, x.type=='Reboot') ? size(self) == 1 : true", message="Reboot action can only be specified standalone, as it will override any other actions" @@ -386,7 +386,7 @@ type NodeDisruptionPolicySpecAction struct { // reload/restart requires a corresponding service target specified in the reload/restart field. // Other values require no further configuration // +unionDiscriminator - // +kubebuilder:validation:Required + // +required Type NodeDisruptionPolicySpecActionType `json:"type"` // reload specifies the service to reload, only valid if type is reload // +optional @@ -405,7 +405,7 @@ type NodeDisruptionPolicyStatusAction struct { // reload/restart requires a corresponding service target specified in the reload/restart field. // Other values require no further configuration // +unionDiscriminator - // +kubebuilder:validation:Required + // +required Type NodeDisruptionPolicyStatusActionType `json:"type"` // reload specifies the service to reload, only valid if type is reload // +optional @@ -421,7 +421,7 @@ type ReloadService struct { // 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". - // +kubebuilder:validation:Required + // +required ServiceName NodeDisruptionPolicyServiceName `json:"serviceName"` } @@ -431,7 +431,7 @@ type RestartService struct { // 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". - // +kubebuilder:validation:Required + // +required ServiceName NodeDisruptionPolicyServiceName `json:"serviceName"` } diff --git a/operator/v1/types_network.go b/operator/v1/types_network.go index 9b1588bc25a..1567b18abaf 100644 --- a/operator/v1/types_network.go +++ b/operator/v1/types_network.go @@ -250,7 +250,7 @@ type DefaultNetworkDefinition struct { // All NetworkTypes are supported except for NetworkTypeRaw Type NetworkType `json:"type"` - // openShiftSDNConfig was previously used to configure the openshift-sdn plugin. + // openshiftSDNConfig was previously used to configure the openshift-sdn plugin. // DEPRECATED: OpenShift SDN is no longer supported. // +optional OpenShiftSDNConfig *OpenShiftSDNConfig `json:"openshiftSDNConfig,omitempty"` @@ -267,7 +267,7 @@ type SimpleMacvlanConfig struct { // +optional Master string `json:"master,omitempty"` - // IPAMConfig configures IPAM module will be used for IP Address Management (IPAM). + // ipamConfig configures IPAM module will be used for IP Address Management (IPAM). // +optional IPAMConfig *IPAMConfig `json:"ipamConfig,omitempty"` @@ -284,19 +284,19 @@ type SimpleMacvlanConfig struct { // StaticIPAMAddresses provides IP address and Gateway for static IPAM addresses type StaticIPAMAddresses struct { - // Address is the IP address in CIDR format + // address is the IP address in CIDR format // +optional Address string `json:"address"` - // Gateway is IP inside of subnet to designate as the gateway + // gateway is IP inside of subnet to designate as the gateway // +optional Gateway string `json:"gateway,omitempty"` } // StaticIPAMRoutes provides Destination/Gateway pairs for static IPAM routes type StaticIPAMRoutes struct { - // Destination points the IP route destination + // destination points the IP route destination Destination string `json:"destination"` - // Gateway is the route's next-hop IP address + // gateway is the route's next-hop IP address // If unset, a default gateway is assumed (as determined by the CNI plugin). // +optional Gateway string `json:"gateway,omitempty"` @@ -304,14 +304,14 @@ type StaticIPAMRoutes struct { // StaticIPAMDNS provides DNS related information for static IPAM type StaticIPAMDNS struct { - // Nameservers points DNS servers for IP lookup + // nameservers points DNS servers for IP lookup // +optional // +listType=atomic Nameservers []string `json:"nameservers,omitempty"` - // Domain configures the domainname the local domain used for short hostname lookups + // domain configures the domainname the local domain used for short hostname lookups // +optional Domain string `json:"domain,omitempty"` - // Search configures priority ordered search domains for short hostname lookups + // search configures priority ordered search domains for short hostname lookups // +optional // +listType=atomic Search []string `json:"search,omitempty"` @@ -319,26 +319,26 @@ type StaticIPAMDNS struct { // StaticIPAMConfig contains configurations for static IPAM (IP Address Management) type StaticIPAMConfig struct { - // Addresses configures IP address for the interface + // addresses configures IP address for the interface // +optional // +listType=atomic Addresses []StaticIPAMAddresses `json:"addresses,omitempty"` - // Routes configures IP routes for the interface + // routes configures IP routes for the interface // +optional // +listType=atomic Routes []StaticIPAMRoutes `json:"routes,omitempty"` - // DNS configures DNS for the interface + // dns configures DNS for the interface // +optional DNS *StaticIPAMDNS `json:"dns,omitempty"` } // IPAMConfig contains configurations for IPAM (IP Address Management) type IPAMConfig struct { - // Type is the type of IPAM module will be used for IP Address Management(IPAM). + // type is the type of IPAM module will be used for IP Address Management(IPAM). // The supported values are IPAMTypeDHCP, IPAMTypeStatic Type IPAMType `json:"type"` - // StaticIPAMConfig configures the static IP address in case of type:IPAMTypeStatic + // staticIPAMConfig configures the static IP address in case of type:IPAMTypeStatic // +optional StaticIPAMConfig *StaticIPAMConfig `json:"staticIPAMConfig,omitempty"` } @@ -353,7 +353,7 @@ type AdditionalNetworkDefinition struct { // name is the name of the network. This will be populated in the resulting CRD // This must be unique. - // +kubebuilder:validation:Required + // +required Name string `json:"name"` // namespace is the namespace of the network. This will be populated in the resulting CRD @@ -364,7 +364,7 @@ type AdditionalNetworkDefinition struct { // NetworkAttachmentDefinition CRD RawCNIConfig string `json:"rawCNIConfig,omitempty"` - // SimpleMacvlanConfig configures the macvlan interface in case of type:NetworkTypeSimpleMacvlan + // simpleMacvlanConfig configures the macvlan interface in case of type:NetworkTypeSimpleMacvlan // +optional SimpleMacvlanConfig *SimpleMacvlanConfig `json:"simpleMacvlanConfig,omitempty"` } @@ -410,7 +410,7 @@ type OVNKubernetesConfig struct { // +kubebuilder:validation:Minimum=1 // +optional GenevePort *uint32 `json:"genevePort,omitempty"` - // HybridOverlayConfig configures an additional overlay network for peers that are + // hybridOverlayConfig configures an additional overlay network for peers that are // not using OVN. // +optional HybridOverlayConfig *HybridOverlayConfig `json:"hybridOverlayConfig,omitempty"` @@ -540,10 +540,10 @@ type IPv6OVNKubernetesConfig struct { } type HybridOverlayConfig struct { - // HybridClusterNetwork defines a network space given to nodes on an additional overlay network. + // hybridClusterNetwork defines a network space given to nodes on an additional overlay network. // +listType=atomic HybridClusterNetwork []ClusterNetworkEntry `json:"hybridClusterNetwork"` - // HybridOverlayVXLANPort defines the VXLAN port number to be used by the additional overlay network. + // hybridOverlayVXLANPort defines the VXLAN port number to be used by the additional overlay network. // Default is 4789 // +optional HybridOverlayVXLANPort *uint32 `json:"hybridOverlayVXLANPort,omitempty"` @@ -577,7 +577,7 @@ const ( // GatewayConfig holds node gateway-related parsed config file parameters and command-line overrides type GatewayConfig struct { - // RoutingViaHost allows pod egress traffic to exit via the ovn-k8s-mp0 management port + // 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. @@ -862,7 +862,7 @@ type AdditionalRoutingCapabilities struct { // is currrently "FRR" which provides FRR routing capabilities through the // deployment of FRR. // +listType=atomic - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:MinItems=1 // +kubebuilder:validation:MaxItems=1 // +kubebuilder:validation:XValidation:rule="self.all(x, self.exists_one(y, x == y))" diff --git a/operator/v1/types_olm.go b/operator/v1/types_olm.go index 1ce349d357f..07c94ece2e2 100644 --- a/operator/v1/types_olm.go +++ b/operator/v1/types_olm.go @@ -56,6 +56,6 @@ type OLMList struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ListMeta `json:"metadata"` - // Items contains the items + // items contains the items Items []OLM `json:"items"` } diff --git a/operator/v1/types_openshiftapiserver.go b/operator/v1/types_openshiftapiserver.go index cd2c8a588f5..a96e033cb7b 100644 --- a/operator/v1/types_openshiftapiserver.go +++ b/operator/v1/types_openshiftapiserver.go @@ -25,7 +25,6 @@ type OpenShiftAPIServer struct { metav1.ObjectMeta `json:"metadata"` // spec is the specification of the desired behavior of the OpenShift API Server. - // +kubebuilder:validation:Required // +required Spec OpenShiftAPIServerSpec `json:"spec"` @@ -55,6 +54,6 @@ type OpenShiftAPIServerList struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ListMeta `json:"metadata"` - // Items contains the items + // items contains the items Items []OpenShiftAPIServer `json:"items"` } diff --git a/operator/v1/types_openshiftcontrollermanager.go b/operator/v1/types_openshiftcontrollermanager.go index 8e8929a903e..8a553a05790 100644 --- a/operator/v1/types_openshiftcontrollermanager.go +++ b/operator/v1/types_openshiftcontrollermanager.go @@ -24,7 +24,6 @@ type OpenShiftControllerManager struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata"` - // +kubebuilder:validation:Required // +required Spec OpenShiftControllerManagerSpec `json:"spec"` // +optional @@ -52,6 +51,6 @@ type OpenShiftControllerManagerList struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ListMeta `json:"metadata"` - // Items contains the items + // items contains the items Items []OpenShiftControllerManager `json:"items"` } diff --git a/operator/v1/types_scheduler.go b/operator/v1/types_scheduler.go index 448c458c199..cfb04e8d94f 100644 --- a/operator/v1/types_scheduler.go +++ b/operator/v1/types_scheduler.go @@ -25,7 +25,6 @@ type KubeScheduler struct { metav1.ObjectMeta `json:"metadata"` // spec is the specification of the desired behavior of the Kubernetes Scheduler - // +kubebuilder:validation:Required // +required Spec KubeSchedulerSpec `json:"spec"` @@ -55,6 +54,6 @@ type KubeSchedulerList struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ListMeta `json:"metadata"` - // Items contains the items + // items contains the items Items []KubeScheduler `json:"items"` } diff --git a/operator/v1/types_serviceca.go b/operator/v1/types_serviceca.go index e4d8d1d7ad9..48534d4c63b 100644 --- a/operator/v1/types_serviceca.go +++ b/operator/v1/types_serviceca.go @@ -25,7 +25,6 @@ type ServiceCA struct { metav1.ObjectMeta `json:"metadata"` //spec holds user settable values for configuration - // +kubebuilder:validation:Required // +required Spec ServiceCASpec `json:"spec"` // status holds observed values from the cluster. They may not be overridden. @@ -54,6 +53,6 @@ type ServiceCAList struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ListMeta `json:"metadata"` - // Items contains the items + // items contains the items Items []ServiceCA `json:"items"` } diff --git a/operator/v1/types_servicecatalogapiserver.go b/operator/v1/types_servicecatalogapiserver.go index 006b8bb99de..e058c065a67 100644 --- a/operator/v1/types_servicecatalogapiserver.go +++ b/operator/v1/types_servicecatalogapiserver.go @@ -20,7 +20,6 @@ type ServiceCatalogAPIServer struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata,omitempty"` - // +kubebuilder:validation:Required // +required Spec ServiceCatalogAPIServerSpec `json:"spec"` // +optional @@ -49,6 +48,6 @@ type ServiceCatalogAPIServerList struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ListMeta `json:"metadata"` - // Items contains the items + // items contains the items Items []ServiceCatalogAPIServer `json:"items"` } diff --git a/operator/v1/types_servicecatalogcontrollermanager.go b/operator/v1/types_servicecatalogcontrollermanager.go index 859965408b5..4fe2aa46a32 100644 --- a/operator/v1/types_servicecatalogcontrollermanager.go +++ b/operator/v1/types_servicecatalogcontrollermanager.go @@ -20,7 +20,6 @@ type ServiceCatalogControllerManager struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata"` - // +kubebuilder:validation:Required // +required Spec ServiceCatalogControllerManagerSpec `json:"spec"` // +optional @@ -49,6 +48,6 @@ type ServiceCatalogControllerManagerList struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ListMeta `json:"metadata"` - // Items contains the items + // items contains the items Items []ServiceCatalogControllerManager `json:"items"` } diff --git a/operator/v1/types_storage.go b/operator/v1/types_storage.go index aa48b0c84f2..69691a83ade 100644 --- a/operator/v1/types_storage.go +++ b/operator/v1/types_storage.go @@ -25,7 +25,6 @@ type Storage struct { metav1.ObjectMeta `json:"metadata,omitempty"` // spec holds user settable values for configuration - // +kubebuilder:validation:Required // +required Spec StorageSpec `json:"spec"` @@ -47,7 +46,7 @@ const ( type StorageSpec struct { OperatorSpec `json:",inline"` - // VSphereStorageDriver indicates the storage driver to use on VSphere clusters. + // 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. diff --git a/operator/v1/zz_generated.crd-manifests/0000_40_cloud-credential_00_cloudcredentials.crd.yaml b/operator/v1/zz_generated.crd-manifests/0000_40_cloud-credential_00_cloudcredentials.crd.yaml index bf6c616afc6..1414aebd7dc 100644 --- a/operator/v1/zz_generated.crd-manifests/0000_40_cloud-credential_00_cloudcredentials.crd.yaml +++ b/operator/v1/zz_generated.crd-manifests/0000_40_cloud-credential_00_cloudcredentials.crd.yaml @@ -48,7 +48,7 @@ spec: properties: credentialsMode: description: |- - CredentialsMode allows informing CCO that it should not attempt to dynamically + 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. diff --git a/operator/v1/zz_generated.crd-manifests/0000_50_authentication_01_authentications.crd.yaml b/operator/v1/zz_generated.crd-manifests/0000_50_authentication_01_authentications.crd.yaml index 3fab2ff1f5c..029c91ac0fb 100644 --- a/operator/v1/zz_generated.crd-manifests/0000_50_authentication_01_authentications.crd.yaml +++ b/operator/v1/zz_generated.crd-manifests/0000_50_authentication_01_authentications.crd.yaml @@ -185,11 +185,11 @@ spec: - message: must only increase rule: self >= oldSelf oauthAPIServer: - description: OAuthAPIServer holds status specific only to oauth-apiserver + description: oauthAPIServer holds status specific only to oauth-apiserver properties: latestAvailableRevision: description: |- - LatestAvailableRevision is the latest revision used as suffix of revisioned + latestAvailableRevision is the latest revision used as suffix of revisioned secrets like encryption-config. A new revision causes a new deployment of pods. format: int32 minimum: 0 diff --git a/operator/v1/zz_generated.crd-manifests/0000_50_console_01_consoles.crd.yaml b/operator/v1/zz_generated.crd-manifests/0000_50_console_01_consoles.crd.yaml index 505332e4b54..6578035ed12 100644 --- a/operator/v1/zz_generated.crd-manifests/0000_50_console_01_consoles.crd.yaml +++ b/operator/v1/zz_generated.crd-manifests/0000_50_console_01_consoles.crd.yaml @@ -141,7 +141,7 @@ spec: SVG format preferred properties: key: - description: Key allows pointing to a specific key/value inside + description: key allows pointing to a specific key/value inside of the configmap. This is useful for logical file references. type: string name: @@ -164,7 +164,7 @@ spec: properties: id: description: |- - ID is an identifier used in the URL to enable deep linking in console. + 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. maxLength: 32 minLength: 1 @@ -184,7 +184,7 @@ spec: properties: id: description: |- - ID is an identifier used in the URL to enable deep linking in console. + 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. maxLength: 32 minLength: 1 diff --git a/operator/v1/zz_generated.crd-manifests/0000_50_csi-driver_01_clustercsidrivers.crd.yaml b/operator/v1/zz_generated.crd-manifests/0000_50_csi-driver_01_clustercsidrivers.crd.yaml index 9a65a695acd..1db446757eb 100644 --- a/operator/v1/zz_generated.crd-manifests/0000_50_csi-driver_01_clustercsidrivers.crd.yaml +++ b/operator/v1/zz_generated.crd-manifests/0000_50_csi-driver_01_clustercsidrivers.crd.yaml @@ -253,7 +253,7 @@ spec: - encryptionKeyCRN type: object vSphere: - description: vsphere is used to configure the vsphere CSI driver. + description: vSphere is used to configure the vsphere CSI driver. properties: globalMaxSnapshotsPerBlockVolume: description: |- @@ -348,7 +348,7 @@ spec: type: string storageClassState: description: |- - StorageClassState determines if CSI operator should create and manage storage classes. + 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 diff --git a/operator/v1/zz_generated.crd-manifests/0000_50_ingress_00_ingresscontrollers.crd.yaml b/operator/v1/zz_generated.crd-manifests/0000_50_ingress_00_ingresscontrollers.crd.yaml index 2524b5a84a2..0ab44a84848 100644 --- a/operator/v1/zz_generated.crd-manifests/0000_50_ingress_00_ingresscontrollers.crd.yaml +++ b/operator/v1/zz_generated.crd-manifests/0000_50_ingress_00_ingresscontrollers.crd.yaml @@ -2089,7 +2089,7 @@ spec: type: string connectTimeout: description: |- - ConnectTimeout defines the maximum time to wait for + connectTimeout defines the maximum time to wait for a connection attempt to a server/backend to succeed. This field expects an unsigned duration string of decimal numbers, each with optional diff --git a/operator/v1/zz_generated.crd-manifests/0000_50_storage_01_storages.crd.yaml b/operator/v1/zz_generated.crd-manifests/0000_50_storage_01_storages.crd.yaml index e0f84188143..2432d6c8bdc 100644 --- a/operator/v1/zz_generated.crd-manifests/0000_50_storage_01_storages.crd.yaml +++ b/operator/v1/zz_generated.crd-manifests/0000_50_storage_01_storages.crd.yaml @@ -98,7 +98,7 @@ spec: x-kubernetes-preserve-unknown-fields: true vsphereStorageDriver: description: |- - VSphereStorageDriver indicates the storage driver to use on VSphere clusters. + 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. diff --git a/operator/v1/zz_generated.crd-manifests/0000_70_dns_00_dnses.crd.yaml b/operator/v1/zz_generated.crd-manifests/0000_70_dns_00_dnses.crd.yaml index 7d2acd004f3..946f6aaade2 100644 --- a/operator/v1/zz_generated.crd-manifests/0000_70_dns_00_dnses.crd.yaml +++ b/operator/v1/zz_generated.crd-manifests/0000_70_dns_00_dnses.crd.yaml @@ -365,7 +365,7 @@ spec: policy: default: Sequential description: |- - Policy is used to determine the order in which upstream servers are selected for querying. + policy is used to determine the order in which upstream servers are selected for querying. Any one of the following values may be specified: * "Random" picks a random upstream server for each query. @@ -466,7 +466,7 @@ spec: default: - type: SystemResolvConf description: |- - Upstreams is a list of resolvers to forward name queries for the "." domain. + 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. @@ -505,13 +505,13 @@ spec: - format: ipv4 - format: ipv6 description: |- - Address must be defined when Type is set to Network. It will be ignored otherwise. + 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: default: 53 description: |- - Port may be defined when Type is set to Network. It will be ignored otherwise. + port may be defined when Type is set to Network. It will be ignored otherwise. Port must be between 65535 format: int32 maximum: 65535 @@ -519,7 +519,7 @@ spec: type: integer type: description: |- - Type defines whether this upstream contains an IP/IP:port resolver or the local /etc/resolv.conf. + 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. * When SystemResolvConf is used, the Upstream structure does not require any further fields to be defined: diff --git a/operator/v1/zz_generated.crd-manifests/0000_70_network_01_networks-CustomNoUpgrade.crd.yaml b/operator/v1/zz_generated.crd-manifests/0000_70_network_01_networks-CustomNoUpgrade.crd.yaml index 146c6840566..f01cfec5b6a 100644 --- a/operator/v1/zz_generated.crd-manifests/0000_70_network_01_networks-CustomNoUpgrade.crd.yaml +++ b/operator/v1/zz_generated.crd-manifests/0000_70_network_01_networks-CustomNoUpgrade.crd.yaml @@ -72,51 +72,51 @@ spec: NetworkAttachmentDefinition CRD type: string simpleMacvlanConfig: - description: SimpleMacvlanConfig configures the macvlan interface + description: simpleMacvlanConfig configures the macvlan interface in case of type:NetworkTypeSimpleMacvlan properties: ipamConfig: - description: IPAMConfig configures IPAM module will be used + description: ipamConfig configures IPAM module will be used for IP Address Management (IPAM). properties: staticIPAMConfig: - description: StaticIPAMConfig configures the static + description: staticIPAMConfig configures the static IP address in case of type:IPAMTypeStatic properties: addresses: - description: Addresses configures IP address for + description: addresses configures IP address for the interface items: description: StaticIPAMAddresses provides IP address and Gateway for static IPAM addresses properties: address: - description: Address is the IP address in + description: address is the IP address in CIDR format type: string gateway: - description: Gateway is IP inside of subnet + description: gateway is IP inside of subnet to designate as the gateway type: string type: object type: array x-kubernetes-list-type: atomic dns: - description: DNS configures DNS for the interface + description: dns configures DNS for the interface properties: domain: - description: Domain configures the domainname + description: domain configures the domainname the local domain used for short hostname lookups type: string nameservers: - description: Nameservers points DNS servers + description: nameservers points DNS servers for IP lookup items: type: string type: array x-kubernetes-list-type: atomic search: - description: Search configures priority ordered + description: search configures priority ordered search domains for short hostname lookups items: type: string @@ -124,19 +124,19 @@ spec: x-kubernetes-list-type: atomic type: object routes: - description: Routes configures IP routes for the + description: routes configures IP routes for the interface items: description: StaticIPAMRoutes provides Destination/Gateway pairs for static IPAM routes properties: destination: - description: Destination points the IP route + description: destination points the IP route destination type: string gateway: description: |- - Gateway is the route's next-hop IP address + gateway is the route's next-hop IP address If unset, a default gateway is assumed (as determined by the CNI plugin). type: string type: object @@ -145,7 +145,7 @@ spec: type: object type: description: |- - Type is the type of IPAM module will be used for IP Address Management(IPAM). + type is the type of IPAM module will be used for IP Address Management(IPAM). The supported values are IPAMTypeDHCP, IPAMTypeStatic type: string type: object @@ -238,7 +238,7 @@ spec: properties: openshiftSDNConfig: description: |- - openShiftSDNConfig was previously used to configure the openshift-sdn plugin. + openshiftSDNConfig was previously used to configure the openshift-sdn plugin. DEPRECATED: OpenShift SDN is no longer supported. properties: enableUnidling: @@ -361,7 +361,7 @@ spec: routingViaHost: default: false description: |- - RoutingViaHost allows pod egress traffic to exit via the ovn-k8s-mp0 management port + 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. @@ -376,11 +376,11 @@ spec: type: integer hybridOverlayConfig: description: |- - HybridOverlayConfig configures an additional overlay network for peers that are + hybridOverlayConfig configures an additional overlay network for peers that are not using OVN. properties: hybridClusterNetwork: - description: HybridClusterNetwork defines a network space + description: hybridClusterNetwork defines a network space given to nodes on an additional overlay network. items: description: |- @@ -400,7 +400,7 @@ spec: x-kubernetes-list-type: atomic hybridOverlayVXLANPort: description: |- - HybridOverlayVXLANPort defines the VXLAN port number to be used by the additional overlay network. + hybridOverlayVXLANPort defines the VXLAN port number to be used by the additional overlay network. Default is 4789 format: int32 type: integer diff --git a/operator/v1/zz_generated.crd-manifests/0000_70_network_01_networks-Default.crd.yaml b/operator/v1/zz_generated.crd-manifests/0000_70_network_01_networks-Default.crd.yaml index 3f150defe73..d8525b69ff1 100644 --- a/operator/v1/zz_generated.crd-manifests/0000_70_network_01_networks-Default.crd.yaml +++ b/operator/v1/zz_generated.crd-manifests/0000_70_network_01_networks-Default.crd.yaml @@ -72,51 +72,51 @@ spec: NetworkAttachmentDefinition CRD type: string simpleMacvlanConfig: - description: SimpleMacvlanConfig configures the macvlan interface + description: simpleMacvlanConfig configures the macvlan interface in case of type:NetworkTypeSimpleMacvlan properties: ipamConfig: - description: IPAMConfig configures IPAM module will be used + description: ipamConfig configures IPAM module will be used for IP Address Management (IPAM). properties: staticIPAMConfig: - description: StaticIPAMConfig configures the static + description: staticIPAMConfig configures the static IP address in case of type:IPAMTypeStatic properties: addresses: - description: Addresses configures IP address for + description: addresses configures IP address for the interface items: description: StaticIPAMAddresses provides IP address and Gateway for static IPAM addresses properties: address: - description: Address is the IP address in + description: address is the IP address in CIDR format type: string gateway: - description: Gateway is IP inside of subnet + description: gateway is IP inside of subnet to designate as the gateway type: string type: object type: array x-kubernetes-list-type: atomic dns: - description: DNS configures DNS for the interface + description: dns configures DNS for the interface properties: domain: - description: Domain configures the domainname + description: domain configures the domainname the local domain used for short hostname lookups type: string nameservers: - description: Nameservers points DNS servers + description: nameservers points DNS servers for IP lookup items: type: string type: array x-kubernetes-list-type: atomic search: - description: Search configures priority ordered + description: search configures priority ordered search domains for short hostname lookups items: type: string @@ -124,19 +124,19 @@ spec: x-kubernetes-list-type: atomic type: object routes: - description: Routes configures IP routes for the + description: routes configures IP routes for the interface items: description: StaticIPAMRoutes provides Destination/Gateway pairs for static IPAM routes properties: destination: - description: Destination points the IP route + description: destination points the IP route destination type: string gateway: description: |- - Gateway is the route's next-hop IP address + gateway is the route's next-hop IP address If unset, a default gateway is assumed (as determined by the CNI plugin). type: string type: object @@ -145,7 +145,7 @@ spec: type: object type: description: |- - Type is the type of IPAM module will be used for IP Address Management(IPAM). + type is the type of IPAM module will be used for IP Address Management(IPAM). The supported values are IPAMTypeDHCP, IPAMTypeStatic type: string type: object @@ -205,7 +205,7 @@ spec: properties: openshiftSDNConfig: description: |- - openShiftSDNConfig was previously used to configure the openshift-sdn plugin. + openshiftSDNConfig was previously used to configure the openshift-sdn plugin. DEPRECATED: OpenShift SDN is no longer supported. properties: enableUnidling: @@ -328,7 +328,7 @@ spec: routingViaHost: default: false description: |- - RoutingViaHost allows pod egress traffic to exit via the ovn-k8s-mp0 management port + 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. @@ -343,11 +343,11 @@ spec: type: integer hybridOverlayConfig: description: |- - HybridOverlayConfig configures an additional overlay network for peers that are + hybridOverlayConfig configures an additional overlay network for peers that are not using OVN. properties: hybridClusterNetwork: - description: HybridClusterNetwork defines a network space + description: hybridClusterNetwork defines a network space given to nodes on an additional overlay network. items: description: |- @@ -367,7 +367,7 @@ spec: x-kubernetes-list-type: atomic hybridOverlayVXLANPort: description: |- - HybridOverlayVXLANPort defines the VXLAN port number to be used by the additional overlay network. + hybridOverlayVXLANPort defines the VXLAN port number to be used by the additional overlay network. Default is 4789 format: int32 type: integer diff --git a/operator/v1/zz_generated.crd-manifests/0000_70_network_01_networks-DevPreviewNoUpgrade.crd.yaml b/operator/v1/zz_generated.crd-manifests/0000_70_network_01_networks-DevPreviewNoUpgrade.crd.yaml index fd067976327..62a173bc568 100644 --- a/operator/v1/zz_generated.crd-manifests/0000_70_network_01_networks-DevPreviewNoUpgrade.crd.yaml +++ b/operator/v1/zz_generated.crd-manifests/0000_70_network_01_networks-DevPreviewNoUpgrade.crd.yaml @@ -72,51 +72,51 @@ spec: NetworkAttachmentDefinition CRD type: string simpleMacvlanConfig: - description: SimpleMacvlanConfig configures the macvlan interface + description: simpleMacvlanConfig configures the macvlan interface in case of type:NetworkTypeSimpleMacvlan properties: ipamConfig: - description: IPAMConfig configures IPAM module will be used + description: ipamConfig configures IPAM module will be used for IP Address Management (IPAM). properties: staticIPAMConfig: - description: StaticIPAMConfig configures the static + description: staticIPAMConfig configures the static IP address in case of type:IPAMTypeStatic properties: addresses: - description: Addresses configures IP address for + description: addresses configures IP address for the interface items: description: StaticIPAMAddresses provides IP address and Gateway for static IPAM addresses properties: address: - description: Address is the IP address in + description: address is the IP address in CIDR format type: string gateway: - description: Gateway is IP inside of subnet + description: gateway is IP inside of subnet to designate as the gateway type: string type: object type: array x-kubernetes-list-type: atomic dns: - description: DNS configures DNS for the interface + description: dns configures DNS for the interface properties: domain: - description: Domain configures the domainname + description: domain configures the domainname the local domain used for short hostname lookups type: string nameservers: - description: Nameservers points DNS servers + description: nameservers points DNS servers for IP lookup items: type: string type: array x-kubernetes-list-type: atomic search: - description: Search configures priority ordered + description: search configures priority ordered search domains for short hostname lookups items: type: string @@ -124,19 +124,19 @@ spec: x-kubernetes-list-type: atomic type: object routes: - description: Routes configures IP routes for the + description: routes configures IP routes for the interface items: description: StaticIPAMRoutes provides Destination/Gateway pairs for static IPAM routes properties: destination: - description: Destination points the IP route + description: destination points the IP route destination type: string gateway: description: |- - Gateway is the route's next-hop IP address + gateway is the route's next-hop IP address If unset, a default gateway is assumed (as determined by the CNI plugin). type: string type: object @@ -145,7 +145,7 @@ spec: type: object type: description: |- - Type is the type of IPAM module will be used for IP Address Management(IPAM). + type is the type of IPAM module will be used for IP Address Management(IPAM). The supported values are IPAMTypeDHCP, IPAMTypeStatic type: string type: object @@ -238,7 +238,7 @@ spec: properties: openshiftSDNConfig: description: |- - openShiftSDNConfig was previously used to configure the openshift-sdn plugin. + openshiftSDNConfig was previously used to configure the openshift-sdn plugin. DEPRECATED: OpenShift SDN is no longer supported. properties: enableUnidling: @@ -361,7 +361,7 @@ spec: routingViaHost: default: false description: |- - RoutingViaHost allows pod egress traffic to exit via the ovn-k8s-mp0 management port + 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. @@ -376,11 +376,11 @@ spec: type: integer hybridOverlayConfig: description: |- - HybridOverlayConfig configures an additional overlay network for peers that are + hybridOverlayConfig configures an additional overlay network for peers that are not using OVN. properties: hybridClusterNetwork: - description: HybridClusterNetwork defines a network space + description: hybridClusterNetwork defines a network space given to nodes on an additional overlay network. items: description: |- @@ -400,7 +400,7 @@ spec: x-kubernetes-list-type: atomic hybridOverlayVXLANPort: description: |- - HybridOverlayVXLANPort defines the VXLAN port number to be used by the additional overlay network. + hybridOverlayVXLANPort defines the VXLAN port number to be used by the additional overlay network. Default is 4789 format: int32 type: integer diff --git a/operator/v1/zz_generated.crd-manifests/0000_70_network_01_networks-TechPreviewNoUpgrade.crd.yaml b/operator/v1/zz_generated.crd-manifests/0000_70_network_01_networks-TechPreviewNoUpgrade.crd.yaml index e55b94afc3e..c404d37d968 100644 --- a/operator/v1/zz_generated.crd-manifests/0000_70_network_01_networks-TechPreviewNoUpgrade.crd.yaml +++ b/operator/v1/zz_generated.crd-manifests/0000_70_network_01_networks-TechPreviewNoUpgrade.crd.yaml @@ -72,51 +72,51 @@ spec: NetworkAttachmentDefinition CRD type: string simpleMacvlanConfig: - description: SimpleMacvlanConfig configures the macvlan interface + description: simpleMacvlanConfig configures the macvlan interface in case of type:NetworkTypeSimpleMacvlan properties: ipamConfig: - description: IPAMConfig configures IPAM module will be used + description: ipamConfig configures IPAM module will be used for IP Address Management (IPAM). properties: staticIPAMConfig: - description: StaticIPAMConfig configures the static + description: staticIPAMConfig configures the static IP address in case of type:IPAMTypeStatic properties: addresses: - description: Addresses configures IP address for + description: addresses configures IP address for the interface items: description: StaticIPAMAddresses provides IP address and Gateway for static IPAM addresses properties: address: - description: Address is the IP address in + description: address is the IP address in CIDR format type: string gateway: - description: Gateway is IP inside of subnet + description: gateway is IP inside of subnet to designate as the gateway type: string type: object type: array x-kubernetes-list-type: atomic dns: - description: DNS configures DNS for the interface + description: dns configures DNS for the interface properties: domain: - description: Domain configures the domainname + description: domain configures the domainname the local domain used for short hostname lookups type: string nameservers: - description: Nameservers points DNS servers + description: nameservers points DNS servers for IP lookup items: type: string type: array x-kubernetes-list-type: atomic search: - description: Search configures priority ordered + description: search configures priority ordered search domains for short hostname lookups items: type: string @@ -124,19 +124,19 @@ spec: x-kubernetes-list-type: atomic type: object routes: - description: Routes configures IP routes for the + description: routes configures IP routes for the interface items: description: StaticIPAMRoutes provides Destination/Gateway pairs for static IPAM routes properties: destination: - description: Destination points the IP route + description: destination points the IP route destination type: string gateway: description: |- - Gateway is the route's next-hop IP address + gateway is the route's next-hop IP address If unset, a default gateway is assumed (as determined by the CNI plugin). type: string type: object @@ -145,7 +145,7 @@ spec: type: object type: description: |- - Type is the type of IPAM module will be used for IP Address Management(IPAM). + type is the type of IPAM module will be used for IP Address Management(IPAM). The supported values are IPAMTypeDHCP, IPAMTypeStatic type: string type: object @@ -238,7 +238,7 @@ spec: properties: openshiftSDNConfig: description: |- - openShiftSDNConfig was previously used to configure the openshift-sdn plugin. + openshiftSDNConfig was previously used to configure the openshift-sdn plugin. DEPRECATED: OpenShift SDN is no longer supported. properties: enableUnidling: @@ -361,7 +361,7 @@ spec: routingViaHost: default: false description: |- - RoutingViaHost allows pod egress traffic to exit via the ovn-k8s-mp0 management port + 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. @@ -376,11 +376,11 @@ spec: type: integer hybridOverlayConfig: description: |- - HybridOverlayConfig configures an additional overlay network for peers that are + hybridOverlayConfig configures an additional overlay network for peers that are not using OVN. properties: hybridClusterNetwork: - description: HybridClusterNetwork defines a network space + description: hybridClusterNetwork defines a network space given to nodes on an additional overlay network. items: description: |- @@ -400,7 +400,7 @@ spec: x-kubernetes-list-type: atomic hybridOverlayVXLANPort: description: |- - HybridOverlayVXLANPort defines the VXLAN port number to be used by the additional overlay network. + hybridOverlayVXLANPort defines the VXLAN port number to be used by the additional overlay network. Default is 4789 format: int32 type: integer diff --git a/operator/v1/zz_generated.featuregated-crd-manifests/authentications.operator.openshift.io/AAA_ungated.yaml b/operator/v1/zz_generated.featuregated-crd-manifests/authentications.operator.openshift.io/AAA_ungated.yaml index 771c6cd8bc6..b35868fc9cb 100644 --- a/operator/v1/zz_generated.featuregated-crd-manifests/authentications.operator.openshift.io/AAA_ungated.yaml +++ b/operator/v1/zz_generated.featuregated-crd-manifests/authentications.operator.openshift.io/AAA_ungated.yaml @@ -188,11 +188,11 @@ spec: - message: must only increase rule: self >= oldSelf oauthAPIServer: - description: OAuthAPIServer holds status specific only to oauth-apiserver + description: oauthAPIServer holds status specific only to oauth-apiserver properties: latestAvailableRevision: description: |- - LatestAvailableRevision is the latest revision used as suffix of revisioned + latestAvailableRevision is the latest revision used as suffix of revisioned secrets like encryption-config. A new revision causes a new deployment of pods. format: int32 minimum: 0 diff --git a/operator/v1/zz_generated.featuregated-crd-manifests/cloudcredentials.operator.openshift.io/AAA_ungated.yaml b/operator/v1/zz_generated.featuregated-crd-manifests/cloudcredentials.operator.openshift.io/AAA_ungated.yaml index 11382fb872f..2a4aee8582a 100644 --- a/operator/v1/zz_generated.featuregated-crd-manifests/cloudcredentials.operator.openshift.io/AAA_ungated.yaml +++ b/operator/v1/zz_generated.featuregated-crd-manifests/cloudcredentials.operator.openshift.io/AAA_ungated.yaml @@ -49,7 +49,7 @@ spec: properties: credentialsMode: description: |- - CredentialsMode allows informing CCO that it should not attempt to dynamically + 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. diff --git a/operator/v1/zz_generated.featuregated-crd-manifests/clustercsidrivers.operator.openshift.io/AAA_ungated.yaml b/operator/v1/zz_generated.featuregated-crd-manifests/clustercsidrivers.operator.openshift.io/AAA_ungated.yaml index ad707b0781d..be2271c5990 100644 --- a/operator/v1/zz_generated.featuregated-crd-manifests/clustercsidrivers.operator.openshift.io/AAA_ungated.yaml +++ b/operator/v1/zz_generated.featuregated-crd-manifests/clustercsidrivers.operator.openshift.io/AAA_ungated.yaml @@ -189,7 +189,7 @@ spec: - encryptionKeyCRN type: object vSphere: - description: vsphere is used to configure the vsphere CSI driver. + description: vSphere is used to configure the vsphere CSI driver. properties: topologyCategories: description: |- @@ -255,7 +255,7 @@ spec: type: string storageClassState: description: |- - StorageClassState determines if CSI operator should create and manage storage classes. + 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 diff --git a/operator/v1/zz_generated.featuregated-crd-manifests/clustercsidrivers.operator.openshift.io/AWSEFSDriverVolumeMetrics.yaml b/operator/v1/zz_generated.featuregated-crd-manifests/clustercsidrivers.operator.openshift.io/AWSEFSDriverVolumeMetrics.yaml index 5cef49c318f..8ea9ac37218 100644 --- a/operator/v1/zz_generated.featuregated-crd-manifests/clustercsidrivers.operator.openshift.io/AWSEFSDriverVolumeMetrics.yaml +++ b/operator/v1/zz_generated.featuregated-crd-manifests/clustercsidrivers.operator.openshift.io/AWSEFSDriverVolumeMetrics.yaml @@ -233,7 +233,7 @@ spec: - encryptionKeyCRN type: object vSphere: - description: vsphere is used to configure the vsphere CSI driver. + description: vSphere is used to configure the vsphere CSI driver. properties: topologyCategories: description: |- @@ -299,7 +299,7 @@ spec: type: string storageClassState: description: |- - StorageClassState determines if CSI operator should create and manage storage classes. + 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 diff --git a/operator/v1/zz_generated.featuregated-crd-manifests/clustercsidrivers.operator.openshift.io/VSphereDriverConfiguration.yaml b/operator/v1/zz_generated.featuregated-crd-manifests/clustercsidrivers.operator.openshift.io/VSphereDriverConfiguration.yaml index c4d81b0aa5f..a8d5682563c 100644 --- a/operator/v1/zz_generated.featuregated-crd-manifests/clustercsidrivers.operator.openshift.io/VSphereDriverConfiguration.yaml +++ b/operator/v1/zz_generated.featuregated-crd-manifests/clustercsidrivers.operator.openshift.io/VSphereDriverConfiguration.yaml @@ -189,7 +189,7 @@ spec: - encryptionKeyCRN type: object vSphere: - description: vsphere is used to configure the vsphere CSI driver. + description: vSphere is used to configure the vsphere CSI driver. properties: globalMaxSnapshotsPerBlockVolume: description: |- @@ -284,7 +284,7 @@ spec: type: string storageClassState: description: |- - StorageClassState determines if CSI operator should create and manage storage classes. + 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 diff --git a/operator/v1/zz_generated.featuregated-crd-manifests/consoles.operator.openshift.io/AAA_ungated.yaml b/operator/v1/zz_generated.featuregated-crd-manifests/consoles.operator.openshift.io/AAA_ungated.yaml index 93d4f95fc0d..4057cc19a4f 100644 --- a/operator/v1/zz_generated.featuregated-crd-manifests/consoles.operator.openshift.io/AAA_ungated.yaml +++ b/operator/v1/zz_generated.featuregated-crd-manifests/consoles.operator.openshift.io/AAA_ungated.yaml @@ -142,7 +142,7 @@ spec: SVG format preferred properties: key: - description: Key allows pointing to a specific key/value inside + description: key allows pointing to a specific key/value inside of the configmap. This is useful for logical file references. type: string name: @@ -165,7 +165,7 @@ spec: properties: id: description: |- - ID is an identifier used in the URL to enable deep linking in console. + 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. maxLength: 32 minLength: 1 @@ -185,7 +185,7 @@ spec: properties: id: description: |- - ID is an identifier used in the URL to enable deep linking in console. + 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. maxLength: 32 minLength: 1 diff --git a/operator/v1/zz_generated.featuregated-crd-manifests/dnses.operator.openshift.io/AAA_ungated.yaml b/operator/v1/zz_generated.featuregated-crd-manifests/dnses.operator.openshift.io/AAA_ungated.yaml index 877f7ca8a96..32f00a1494c 100644 --- a/operator/v1/zz_generated.featuregated-crd-manifests/dnses.operator.openshift.io/AAA_ungated.yaml +++ b/operator/v1/zz_generated.featuregated-crd-manifests/dnses.operator.openshift.io/AAA_ungated.yaml @@ -365,7 +365,7 @@ spec: policy: default: Sequential description: |- - Policy is used to determine the order in which upstream servers are selected for querying. + policy is used to determine the order in which upstream servers are selected for querying. Any one of the following values may be specified: * "Random" picks a random upstream server for each query. @@ -466,7 +466,7 @@ spec: default: - type: SystemResolvConf description: |- - Upstreams is a list of resolvers to forward name queries for the "." domain. + 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. @@ -484,13 +484,13 @@ spec: properties: address: description: |- - Address must be defined when Type is set to Network. It will be ignored otherwise. + 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: default: 53 description: |- - Port may be defined when Type is set to Network. It will be ignored otherwise. + port may be defined when Type is set to Network. It will be ignored otherwise. Port must be between 65535 format: int32 maximum: 65535 @@ -498,7 +498,7 @@ spec: type: integer type: description: |- - Type defines whether this upstream contains an IP/IP:port resolver or the local /etc/resolv.conf. + 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. * When SystemResolvConf is used, the Upstream structure does not require any further fields to be defined: diff --git a/operator/v1/zz_generated.featuregated-crd-manifests/ingresscontrollers.operator.openshift.io/AAA_ungated.yaml b/operator/v1/zz_generated.featuregated-crd-manifests/ingresscontrollers.operator.openshift.io/AAA_ungated.yaml index a0caca44a9c..78109365c78 100644 --- a/operator/v1/zz_generated.featuregated-crd-manifests/ingresscontrollers.operator.openshift.io/AAA_ungated.yaml +++ b/operator/v1/zz_generated.featuregated-crd-manifests/ingresscontrollers.operator.openshift.io/AAA_ungated.yaml @@ -1865,7 +1865,7 @@ spec: type: string connectTimeout: description: |- - ConnectTimeout defines the maximum time to wait for + connectTimeout defines the maximum time to wait for a connection attempt to a server/backend to succeed. This field expects an unsigned duration string of decimal numbers, each with optional diff --git a/operator/v1/zz_generated.featuregated-crd-manifests/ingresscontrollers.operator.openshift.io/IngressControllerLBSubnetsAWS.yaml b/operator/v1/zz_generated.featuregated-crd-manifests/ingresscontrollers.operator.openshift.io/IngressControllerLBSubnetsAWS.yaml index be89438d6a5..8c472a3d0f3 100644 --- a/operator/v1/zz_generated.featuregated-crd-manifests/ingresscontrollers.operator.openshift.io/IngressControllerLBSubnetsAWS.yaml +++ b/operator/v1/zz_generated.featuregated-crd-manifests/ingresscontrollers.operator.openshift.io/IngressControllerLBSubnetsAWS.yaml @@ -2014,7 +2014,7 @@ spec: type: string connectTimeout: description: |- - ConnectTimeout defines the maximum time to wait for + connectTimeout defines the maximum time to wait for a connection attempt to a server/backend to succeed. This field expects an unsigned duration string of decimal numbers, each with optional diff --git a/operator/v1/zz_generated.featuregated-crd-manifests/ingresscontrollers.operator.openshift.io/SetEIPForNLBIngressController.yaml b/operator/v1/zz_generated.featuregated-crd-manifests/ingresscontrollers.operator.openshift.io/SetEIPForNLBIngressController.yaml index c9093ecf8e0..b3b38aeb1ea 100644 --- a/operator/v1/zz_generated.featuregated-crd-manifests/ingresscontrollers.operator.openshift.io/SetEIPForNLBIngressController.yaml +++ b/operator/v1/zz_generated.featuregated-crd-manifests/ingresscontrollers.operator.openshift.io/SetEIPForNLBIngressController.yaml @@ -1924,7 +1924,7 @@ spec: type: string connectTimeout: description: |- - ConnectTimeout defines the maximum time to wait for + connectTimeout defines the maximum time to wait for a connection attempt to a server/backend to succeed. This field expects an unsigned duration string of decimal numbers, each with optional diff --git a/operator/v1/zz_generated.featuregated-crd-manifests/networks.operator.openshift.io/AAA_ungated.yaml b/operator/v1/zz_generated.featuregated-crd-manifests/networks.operator.openshift.io/AAA_ungated.yaml index 189063b765b..b15e5ed997c 100644 --- a/operator/v1/zz_generated.featuregated-crd-manifests/networks.operator.openshift.io/AAA_ungated.yaml +++ b/operator/v1/zz_generated.featuregated-crd-manifests/networks.operator.openshift.io/AAA_ungated.yaml @@ -72,51 +72,51 @@ spec: NetworkAttachmentDefinition CRD type: string simpleMacvlanConfig: - description: SimpleMacvlanConfig configures the macvlan interface + description: simpleMacvlanConfig configures the macvlan interface in case of type:NetworkTypeSimpleMacvlan properties: ipamConfig: - description: IPAMConfig configures IPAM module will be used + description: ipamConfig configures IPAM module will be used for IP Address Management (IPAM). properties: staticIPAMConfig: - description: StaticIPAMConfig configures the static + description: staticIPAMConfig configures the static IP address in case of type:IPAMTypeStatic properties: addresses: - description: Addresses configures IP address for + description: addresses configures IP address for the interface items: description: StaticIPAMAddresses provides IP address and Gateway for static IPAM addresses properties: address: - description: Address is the IP address in + description: address is the IP address in CIDR format type: string gateway: - description: Gateway is IP inside of subnet + description: gateway is IP inside of subnet to designate as the gateway type: string type: object type: array x-kubernetes-list-type: atomic dns: - description: DNS configures DNS for the interface + description: dns configures DNS for the interface properties: domain: - description: Domain configures the domainname + description: domain configures the domainname the local domain used for short hostname lookups type: string nameservers: - description: Nameservers points DNS servers + description: nameservers points DNS servers for IP lookup items: type: string type: array x-kubernetes-list-type: atomic search: - description: Search configures priority ordered + description: search configures priority ordered search domains for short hostname lookups items: type: string @@ -124,19 +124,19 @@ spec: x-kubernetes-list-type: atomic type: object routes: - description: Routes configures IP routes for the + description: routes configures IP routes for the interface items: description: StaticIPAMRoutes provides Destination/Gateway pairs for static IPAM routes properties: destination: - description: Destination points the IP route + description: destination points the IP route destination type: string gateway: description: |- - Gateway is the route's next-hop IP address + gateway is the route's next-hop IP address If unset, a default gateway is assumed (as determined by the CNI plugin). type: string type: object @@ -145,7 +145,7 @@ spec: type: object type: description: |- - Type is the type of IPAM module will be used for IP Address Management(IPAM). + type is the type of IPAM module will be used for IP Address Management(IPAM). The supported values are IPAMTypeDHCP, IPAMTypeStatic type: string type: object @@ -205,7 +205,7 @@ spec: properties: openshiftSDNConfig: description: |- - openShiftSDNConfig was previously used to configure the openshift-sdn plugin. + openshiftSDNConfig was previously used to configure the openshift-sdn plugin. DEPRECATED: OpenShift SDN is no longer supported. properties: enableUnidling: @@ -328,7 +328,7 @@ spec: routingViaHost: default: false description: |- - RoutingViaHost allows pod egress traffic to exit via the ovn-k8s-mp0 management port + 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. @@ -343,11 +343,11 @@ spec: type: integer hybridOverlayConfig: description: |- - HybridOverlayConfig configures an additional overlay network for peers that are + hybridOverlayConfig configures an additional overlay network for peers that are not using OVN. properties: hybridClusterNetwork: - description: HybridClusterNetwork defines a network space + description: hybridClusterNetwork defines a network space given to nodes on an additional overlay network. items: description: |- @@ -367,7 +367,7 @@ spec: x-kubernetes-list-type: atomic hybridOverlayVXLANPort: description: |- - HybridOverlayVXLANPort defines the VXLAN port number to be used by the additional overlay network. + hybridOverlayVXLANPort defines the VXLAN port number to be used by the additional overlay network. Default is 4789 format: int32 type: integer diff --git a/operator/v1/zz_generated.featuregated-crd-manifests/networks.operator.openshift.io/AdditionalRoutingCapabilities.yaml b/operator/v1/zz_generated.featuregated-crd-manifests/networks.operator.openshift.io/AdditionalRoutingCapabilities.yaml index 6e14ebb2eae..7777b2f1c8c 100644 --- a/operator/v1/zz_generated.featuregated-crd-manifests/networks.operator.openshift.io/AdditionalRoutingCapabilities.yaml +++ b/operator/v1/zz_generated.featuregated-crd-manifests/networks.operator.openshift.io/AdditionalRoutingCapabilities.yaml @@ -72,51 +72,51 @@ spec: NetworkAttachmentDefinition CRD type: string simpleMacvlanConfig: - description: SimpleMacvlanConfig configures the macvlan interface + description: simpleMacvlanConfig configures the macvlan interface in case of type:NetworkTypeSimpleMacvlan properties: ipamConfig: - description: IPAMConfig configures IPAM module will be used + description: ipamConfig configures IPAM module will be used for IP Address Management (IPAM). properties: staticIPAMConfig: - description: StaticIPAMConfig configures the static + description: staticIPAMConfig configures the static IP address in case of type:IPAMTypeStatic properties: addresses: - description: Addresses configures IP address for + description: addresses configures IP address for the interface items: description: StaticIPAMAddresses provides IP address and Gateway for static IPAM addresses properties: address: - description: Address is the IP address in + description: address is the IP address in CIDR format type: string gateway: - description: Gateway is IP inside of subnet + description: gateway is IP inside of subnet to designate as the gateway type: string type: object type: array x-kubernetes-list-type: atomic dns: - description: DNS configures DNS for the interface + description: dns configures DNS for the interface properties: domain: - description: Domain configures the domainname + description: domain configures the domainname the local domain used for short hostname lookups type: string nameservers: - description: Nameservers points DNS servers + description: nameservers points DNS servers for IP lookup items: type: string type: array x-kubernetes-list-type: atomic search: - description: Search configures priority ordered + description: search configures priority ordered search domains for short hostname lookups items: type: string @@ -124,19 +124,19 @@ spec: x-kubernetes-list-type: atomic type: object routes: - description: Routes configures IP routes for the + description: routes configures IP routes for the interface items: description: StaticIPAMRoutes provides Destination/Gateway pairs for static IPAM routes properties: destination: - description: Destination points the IP route + description: destination points the IP route destination type: string gateway: description: |- - Gateway is the route's next-hop IP address + gateway is the route's next-hop IP address If unset, a default gateway is assumed (as determined by the CNI plugin). type: string type: object @@ -145,7 +145,7 @@ spec: type: object type: description: |- - Type is the type of IPAM module will be used for IP Address Management(IPAM). + type is the type of IPAM module will be used for IP Address Management(IPAM). The supported values are IPAMTypeDHCP, IPAMTypeStatic type: string type: object @@ -238,7 +238,7 @@ spec: properties: openshiftSDNConfig: description: |- - openShiftSDNConfig was previously used to configure the openshift-sdn plugin. + openshiftSDNConfig was previously used to configure the openshift-sdn plugin. DEPRECATED: OpenShift SDN is no longer supported. properties: enableUnidling: @@ -361,7 +361,7 @@ spec: routingViaHost: default: false description: |- - RoutingViaHost allows pod egress traffic to exit via the ovn-k8s-mp0 management port + 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. @@ -376,11 +376,11 @@ spec: type: integer hybridOverlayConfig: description: |- - HybridOverlayConfig configures an additional overlay network for peers that are + hybridOverlayConfig configures an additional overlay network for peers that are not using OVN. properties: hybridClusterNetwork: - description: HybridClusterNetwork defines a network space + description: hybridClusterNetwork defines a network space given to nodes on an additional overlay network. items: description: |- @@ -400,7 +400,7 @@ spec: x-kubernetes-list-type: atomic hybridOverlayVXLANPort: description: |- - HybridOverlayVXLANPort defines the VXLAN port number to be used by the additional overlay network. + hybridOverlayVXLANPort defines the VXLAN port number to be used by the additional overlay network. Default is 4789 format: int32 type: integer diff --git a/operator/v1/zz_generated.featuregated-crd-manifests/networks.operator.openshift.io/NetworkLiveMigration.yaml b/operator/v1/zz_generated.featuregated-crd-manifests/networks.operator.openshift.io/NetworkLiveMigration.yaml index 8ff1a6ea4b7..fd683d81324 100644 --- a/operator/v1/zz_generated.featuregated-crd-manifests/networks.operator.openshift.io/NetworkLiveMigration.yaml +++ b/operator/v1/zz_generated.featuregated-crd-manifests/networks.operator.openshift.io/NetworkLiveMigration.yaml @@ -72,51 +72,51 @@ spec: NetworkAttachmentDefinition CRD type: string simpleMacvlanConfig: - description: SimpleMacvlanConfig configures the macvlan interface + description: simpleMacvlanConfig configures the macvlan interface in case of type:NetworkTypeSimpleMacvlan properties: ipamConfig: - description: IPAMConfig configures IPAM module will be used + description: ipamConfig configures IPAM module will be used for IP Address Management (IPAM). properties: staticIPAMConfig: - description: StaticIPAMConfig configures the static + description: staticIPAMConfig configures the static IP address in case of type:IPAMTypeStatic properties: addresses: - description: Addresses configures IP address for + description: addresses configures IP address for the interface items: description: StaticIPAMAddresses provides IP address and Gateway for static IPAM addresses properties: address: - description: Address is the IP address in + description: address is the IP address in CIDR format type: string gateway: - description: Gateway is IP inside of subnet + description: gateway is IP inside of subnet to designate as the gateway type: string type: object type: array x-kubernetes-list-type: atomic dns: - description: DNS configures DNS for the interface + description: dns configures DNS for the interface properties: domain: - description: Domain configures the domainname + description: domain configures the domainname the local domain used for short hostname lookups type: string nameservers: - description: Nameservers points DNS servers + description: nameservers points DNS servers for IP lookup items: type: string type: array x-kubernetes-list-type: atomic search: - description: Search configures priority ordered + description: search configures priority ordered search domains for short hostname lookups items: type: string @@ -124,19 +124,19 @@ spec: x-kubernetes-list-type: atomic type: object routes: - description: Routes configures IP routes for the + description: routes configures IP routes for the interface items: description: StaticIPAMRoutes provides Destination/Gateway pairs for static IPAM routes properties: destination: - description: Destination points the IP route + description: destination points the IP route destination type: string gateway: description: |- - Gateway is the route's next-hop IP address + gateway is the route's next-hop IP address If unset, a default gateway is assumed (as determined by the CNI plugin). type: string type: object @@ -145,7 +145,7 @@ spec: type: object type: description: |- - Type is the type of IPAM module will be used for IP Address Management(IPAM). + type is the type of IPAM module will be used for IP Address Management(IPAM). The supported values are IPAMTypeDHCP, IPAMTypeStatic type: string type: object @@ -205,7 +205,7 @@ spec: properties: openshiftSDNConfig: description: |- - openShiftSDNConfig was previously used to configure the openshift-sdn plugin. + openshiftSDNConfig was previously used to configure the openshift-sdn plugin. DEPRECATED: OpenShift SDN is no longer supported. properties: enableUnidling: @@ -328,7 +328,7 @@ spec: routingViaHost: default: false description: |- - RoutingViaHost allows pod egress traffic to exit via the ovn-k8s-mp0 management port + 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. @@ -343,11 +343,11 @@ spec: type: integer hybridOverlayConfig: description: |- - HybridOverlayConfig configures an additional overlay network for peers that are + hybridOverlayConfig configures an additional overlay network for peers that are not using OVN. properties: hybridClusterNetwork: - description: HybridClusterNetwork defines a network space + description: hybridClusterNetwork defines a network space given to nodes on an additional overlay network. items: description: |- @@ -367,7 +367,7 @@ spec: x-kubernetes-list-type: atomic hybridOverlayVXLANPort: description: |- - HybridOverlayVXLANPort defines the VXLAN port number to be used by the additional overlay network. + hybridOverlayVXLANPort defines the VXLAN port number to be used by the additional overlay network. Default is 4789 format: int32 type: integer diff --git a/operator/v1/zz_generated.featuregated-crd-manifests/networks.operator.openshift.io/RouteAdvertisements.yaml b/operator/v1/zz_generated.featuregated-crd-manifests/networks.operator.openshift.io/RouteAdvertisements.yaml index e4caccb1e07..62fc5856ad5 100644 --- a/operator/v1/zz_generated.featuregated-crd-manifests/networks.operator.openshift.io/RouteAdvertisements.yaml +++ b/operator/v1/zz_generated.featuregated-crd-manifests/networks.operator.openshift.io/RouteAdvertisements.yaml @@ -72,51 +72,51 @@ spec: NetworkAttachmentDefinition CRD type: string simpleMacvlanConfig: - description: SimpleMacvlanConfig configures the macvlan interface + description: simpleMacvlanConfig configures the macvlan interface in case of type:NetworkTypeSimpleMacvlan properties: ipamConfig: - description: IPAMConfig configures IPAM module will be used + description: ipamConfig configures IPAM module will be used for IP Address Management (IPAM). properties: staticIPAMConfig: - description: StaticIPAMConfig configures the static + description: staticIPAMConfig configures the static IP address in case of type:IPAMTypeStatic properties: addresses: - description: Addresses configures IP address for + description: addresses configures IP address for the interface items: description: StaticIPAMAddresses provides IP address and Gateway for static IPAM addresses properties: address: - description: Address is the IP address in + description: address is the IP address in CIDR format type: string gateway: - description: Gateway is IP inside of subnet + description: gateway is IP inside of subnet to designate as the gateway type: string type: object type: array x-kubernetes-list-type: atomic dns: - description: DNS configures DNS for the interface + description: dns configures DNS for the interface properties: domain: - description: Domain configures the domainname + description: domain configures the domainname the local domain used for short hostname lookups type: string nameservers: - description: Nameservers points DNS servers + description: nameservers points DNS servers for IP lookup items: type: string type: array x-kubernetes-list-type: atomic search: - description: Search configures priority ordered + description: search configures priority ordered search domains for short hostname lookups items: type: string @@ -124,19 +124,19 @@ spec: x-kubernetes-list-type: atomic type: object routes: - description: Routes configures IP routes for the + description: routes configures IP routes for the interface items: description: StaticIPAMRoutes provides Destination/Gateway pairs for static IPAM routes properties: destination: - description: Destination points the IP route + description: destination points the IP route destination type: string gateway: description: |- - Gateway is the route's next-hop IP address + gateway is the route's next-hop IP address If unset, a default gateway is assumed (as determined by the CNI plugin). type: string type: object @@ -145,7 +145,7 @@ spec: type: object type: description: |- - Type is the type of IPAM module will be used for IP Address Management(IPAM). + type is the type of IPAM module will be used for IP Address Management(IPAM). The supported values are IPAMTypeDHCP, IPAMTypeStatic type: string type: object @@ -205,7 +205,7 @@ spec: properties: openshiftSDNConfig: description: |- - openShiftSDNConfig was previously used to configure the openshift-sdn plugin. + openshiftSDNConfig was previously used to configure the openshift-sdn plugin. DEPRECATED: OpenShift SDN is no longer supported. properties: enableUnidling: @@ -328,7 +328,7 @@ spec: routingViaHost: default: false description: |- - RoutingViaHost allows pod egress traffic to exit via the ovn-k8s-mp0 management port + 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. @@ -343,11 +343,11 @@ spec: type: integer hybridOverlayConfig: description: |- - HybridOverlayConfig configures an additional overlay network for peers that are + hybridOverlayConfig configures an additional overlay network for peers that are not using OVN. properties: hybridClusterNetwork: - description: HybridClusterNetwork defines a network space + description: hybridClusterNetwork defines a network space given to nodes on an additional overlay network. items: description: |- @@ -367,7 +367,7 @@ spec: x-kubernetes-list-type: atomic hybridOverlayVXLANPort: description: |- - HybridOverlayVXLANPort defines the VXLAN port number to be used by the additional overlay network. + hybridOverlayVXLANPort defines the VXLAN port number to be used by the additional overlay network. Default is 4789 format: int32 type: integer diff --git a/operator/v1/zz_generated.featuregated-crd-manifests/storages.operator.openshift.io/AAA_ungated.yaml b/operator/v1/zz_generated.featuregated-crd-manifests/storages.operator.openshift.io/AAA_ungated.yaml index eeda8583ad4..25501ff98c1 100644 --- a/operator/v1/zz_generated.featuregated-crd-manifests/storages.operator.openshift.io/AAA_ungated.yaml +++ b/operator/v1/zz_generated.featuregated-crd-manifests/storages.operator.openshift.io/AAA_ungated.yaml @@ -99,7 +99,7 @@ spec: x-kubernetes-preserve-unknown-fields: true vsphereStorageDriver: description: |- - VSphereStorageDriver indicates the storage driver to use on VSphere clusters. + 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. diff --git a/operator/v1/zz_generated.swagger_doc_generated.go b/operator/v1/zz_generated.swagger_doc_generated.go index 3c00fe2f032..12f1a26e399 100644 --- a/operator/v1/zz_generated.swagger_doc_generated.go +++ b/operator/v1/zz_generated.swagger_doc_generated.go @@ -128,7 +128,7 @@ func (AuthenticationList) SwaggerDoc() map[string]string { } var map_AuthenticationStatus = map[string]string{ - "oauthAPIServer": "OAuthAPIServer holds status specific only to oauth-apiserver", + "oauthAPIServer": "oauthAPIServer holds status specific only to oauth-apiserver", } func (AuthenticationStatus) SwaggerDoc() map[string]string { @@ -136,7 +136,7 @@ func (AuthenticationStatus) SwaggerDoc() map[string]string { } var map_OAuthAPIServerStatus = map[string]string{ - "latestAvailableRevision": "LatestAvailableRevision is the latest revision used as suffix of revisioned secrets like encryption-config. A new revision causes a new deployment of pods.", + "latestAvailableRevision": "latestAvailableRevision is the latest revision used as suffix of revisioned secrets like encryption-config. A new revision causes a new deployment of pods.", } func (OAuthAPIServerStatus) SwaggerDoc() map[string]string { @@ -163,7 +163,7 @@ func (CloudCredentialList) SwaggerDoc() map[string]string { var map_CloudCredentialSpec = map[string]string{ "": "CloudCredentialSpec is the specification of the desired behavior of the cloud-credential-operator.", - "credentialsMode": "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\"", + "credentialsMode": "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\"", } func (CloudCredentialSpec) SwaggerDoc() map[string]string { @@ -192,7 +192,7 @@ func (Config) SwaggerDoc() map[string]string { var map_ConfigList = map[string]string{ "": "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).", "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "items": "Items contains the items", + "items": "items contains the items", } func (ConfigList) SwaggerDoc() map[string]string { @@ -314,7 +314,7 @@ func (DeveloperConsoleCatalogCategory) SwaggerDoc() map[string]string { var map_DeveloperConsoleCatalogCategoryMeta = map[string]string{ "": "DeveloperConsoleCatalogCategoryMeta are the key identifiers of a developer catalog category.", - "id": "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.", + "id": "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.", "label": "label defines a category display label. It is required and must have 1-64 characters.", "tags": "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.", } @@ -480,7 +480,7 @@ var map_CSIDriverConfigSpec = map[string]string{ "azure": "azure is used to configure the Azure CSI driver.", "gcp": "gcp is used to configure the GCP CSI driver.", "ibmcloud": "ibmcloud is used to configure the IBM Cloud CSI driver.", - "vSphere": "vsphere is used to configure the vsphere CSI driver.", + "vSphere": "vSphere is used to configure the vsphere CSI driver.", } func (CSIDriverConfigSpec) SwaggerDoc() map[string]string { @@ -509,7 +509,7 @@ func (ClusterCSIDriverList) SwaggerDoc() map[string]string { var map_ClusterCSIDriverSpec = map[string]string{ "": "ClusterCSIDriverSpec is the desired behavior of CSI driver operator", - "storageClassState": "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.", + "storageClassState": "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.", "driverConfig": "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.", } @@ -714,9 +714,9 @@ func (Server) SwaggerDoc() map[string]string { var map_Upstream = map[string]string{ "": "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.", - "type": "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", - "address": "Address must be defined when Type is set to Network. It will be ignored otherwise. It must be a valid ipv4 or ipv6 address.", - "port": "Port may be defined when Type is set to Network. It will be ignored otherwise. Port must be between 65535", + "type": "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", + "address": "address must be defined when Type is set to Network. It will be ignored otherwise. It must be a valid ipv4 or ipv6 address.", + "port": "port may be defined when Type is set to Network. It will be ignored otherwise. Port must be between 65535", } func (Upstream) SwaggerDoc() map[string]string { @@ -725,8 +725,8 @@ func (Upstream) SwaggerDoc() map[string]string { var map_UpstreamResolvers = map[string]string{ "": "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", - "upstreams": "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", - "policy": "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\"", + "upstreams": "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", + "policy": "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\"", "transportConfig": "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.", "protocolStrategy": "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.", } @@ -747,7 +747,7 @@ func (Etcd) SwaggerDoc() map[string]string { var map_EtcdList = map[string]string{ "": "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).", "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "items": "Items contains the items", + "items": "items contains the items", } func (EtcdList) SwaggerDoc() map[string]string { @@ -1071,7 +1071,7 @@ var map_IngressControllerTuningOptions = map[string]string{ "serverTimeout": "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", "serverFinTimeout": "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", "tunnelTimeout": "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", - "connectTimeout": "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.", + "connectTimeout": "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.", "tlsInspectDelay": "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", "healthCheckInterval": "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.", "maxConnections": "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\"}'.", @@ -1264,7 +1264,7 @@ func (KubeAPIServer) SwaggerDoc() map[string]string { var map_KubeAPIServerList = map[string]string{ "": "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).", "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "items": "Items contains the items", + "items": "items contains the items", } func (KubeAPIServerList) SwaggerDoc() map[string]string { @@ -1302,7 +1302,7 @@ func (KubeControllerManager) SwaggerDoc() map[string]string { var map_KubeControllerManagerList = map[string]string{ "": "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).", "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "items": "Items contains the items", + "items": "items contains the items", } func (KubeControllerManagerList) SwaggerDoc() map[string]string { @@ -1329,7 +1329,7 @@ func (KubeStorageVersionMigrator) SwaggerDoc() map[string]string { var map_KubeStorageVersionMigratorList = map[string]string{ "": "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).", "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "items": "Items contains the items", + "items": "items contains the items", } func (KubeStorageVersionMigratorList) SwaggerDoc() map[string]string { @@ -1350,7 +1350,7 @@ func (MachineConfiguration) SwaggerDoc() map[string]string { var map_MachineConfigurationList = map[string]string{ "": "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).", "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "items": "Items contains the items", + "items": "items contains the items", } func (MachineConfigurationList) SwaggerDoc() map[string]string { @@ -1545,7 +1545,7 @@ var map_AdditionalNetworkDefinition = map[string]string{ "name": "name is the name of the network. This will be populated in the resulting CRD This must be unique.", "namespace": "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.", "rawCNIConfig": "rawCNIConfig is the raw CNI configuration json to create in the NetworkAttachmentDefinition CRD", - "simpleMacvlanConfig": "SimpleMacvlanConfig configures the macvlan interface in case of type:NetworkTypeSimpleMacvlan", + "simpleMacvlanConfig": "simpleMacvlanConfig configures the macvlan interface in case of type:NetworkTypeSimpleMacvlan", } func (AdditionalNetworkDefinition) SwaggerDoc() map[string]string { @@ -1572,7 +1572,7 @@ func (ClusterNetworkEntry) SwaggerDoc() map[string]string { var map_DefaultNetworkDefinition = map[string]string{ "": "DefaultNetworkDefinition represents a single network plugin's configuration. type must be specified, along with exactly one \"Config\" that matches the type.", "type": "type is the type of network All NetworkTypes are supported except for NetworkTypeRaw", - "openshiftSDNConfig": "openShiftSDNConfig was previously used to configure the openshift-sdn plugin. DEPRECATED: OpenShift SDN is no longer supported.", + "openshiftSDNConfig": "openshiftSDNConfig was previously used to configure the openshift-sdn plugin. DEPRECATED: OpenShift SDN is no longer supported.", "ovnKubernetesConfig": "ovnKubernetesConfig configures the ovn-kubernetes plugin.", } @@ -1611,7 +1611,7 @@ func (FeaturesMigration) SwaggerDoc() map[string]string { var map_GatewayConfig = map[string]string{ "": "GatewayConfig holds node gateway-related parsed config file parameters and command-line overrides", - "routingViaHost": "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.", + "routingViaHost": "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.", "ipForwarding": "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\".", "ipv4": "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.", "ipv6": "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.", @@ -1622,8 +1622,8 @@ func (GatewayConfig) SwaggerDoc() map[string]string { } var map_HybridOverlayConfig = map[string]string{ - "hybridClusterNetwork": "HybridClusterNetwork defines a network space given to nodes on an additional overlay network.", - "hybridOverlayVXLANPort": "HybridOverlayVXLANPort defines the VXLAN port number to be used by the additional overlay network. Default is 4789", + "hybridClusterNetwork": "hybridClusterNetwork defines a network space given to nodes on an additional overlay network.", + "hybridOverlayVXLANPort": "hybridOverlayVXLANPort defines the VXLAN port number to be used by the additional overlay network. Default is 4789", } func (HybridOverlayConfig) SwaggerDoc() map[string]string { @@ -1632,8 +1632,8 @@ func (HybridOverlayConfig) SwaggerDoc() map[string]string { var map_IPAMConfig = map[string]string{ "": "IPAMConfig contains configurations for IPAM (IP Address Management)", - "type": "Type is the type of IPAM module will be used for IP Address Management(IPAM). The supported values are IPAMTypeDHCP, IPAMTypeStatic", - "staticIPAMConfig": "StaticIPAMConfig configures the static IP address in case of type:IPAMTypeStatic", + "type": "type is the type of IPAM module will be used for IP Address Management(IPAM). The supported values are IPAMTypeDHCP, IPAMTypeStatic", + "staticIPAMConfig": "staticIPAMConfig configures the static IP address in case of type:IPAMTypeStatic", } func (IPAMConfig) SwaggerDoc() map[string]string { @@ -1782,7 +1782,7 @@ var map_OVNKubernetesConfig = map[string]string{ "": "ovnKubernetesConfig contains the configuration parameters for networks using the ovn-kubernetes network project", "mtu": "mtu is the MTU to use for the tunnel interface. This must be 100 bytes smaller than the uplink mtu. Default is 1400", "genevePort": "geneve port is the UDP port to be used by geneve encapulation. Default is 6081", - "hybridOverlayConfig": "HybridOverlayConfig configures an additional overlay network for peers that are not using OVN.", + "hybridOverlayConfig": "hybridOverlayConfig configures an additional overlay network for peers that are not using OVN.", "ipsecConfig": "ipsecConfig enables and configures IPsec for pods on the pod network within the cluster.", "policyAuditConfig": "policyAuditConfig is the configuration for network policy audit events. If unset, reported defaults are used.", "gatewayConfig": "gatewayConfig holds the configuration for node gateway options.", @@ -1845,7 +1845,7 @@ func (SFlowConfig) SwaggerDoc() map[string]string { var map_SimpleMacvlanConfig = map[string]string{ "": "SimpleMacvlanConfig contains configurations for macvlan interface.", "master": "master is the host interface to create the macvlan interface from. If not specified, it will be default route interface", - "ipamConfig": "IPAMConfig configures IPAM module will be used for IP Address Management (IPAM).", + "ipamConfig": "ipamConfig configures IPAM module will be used for IP Address Management (IPAM).", "mode": "mode is the macvlan mode: bridge, private, vepa, passthru. The default is bridge", "mtu": "mtu is the mtu to use for the macvlan interface. if unset, host's kernel will select the value.", } @@ -1856,8 +1856,8 @@ func (SimpleMacvlanConfig) SwaggerDoc() map[string]string { var map_StaticIPAMAddresses = map[string]string{ "": "StaticIPAMAddresses provides IP address and Gateway for static IPAM addresses", - "address": "Address is the IP address in CIDR format", - "gateway": "Gateway is IP inside of subnet to designate as the gateway", + "address": "address is the IP address in CIDR format", + "gateway": "gateway is IP inside of subnet to designate as the gateway", } func (StaticIPAMAddresses) SwaggerDoc() map[string]string { @@ -1866,9 +1866,9 @@ func (StaticIPAMAddresses) SwaggerDoc() map[string]string { var map_StaticIPAMConfig = map[string]string{ "": "StaticIPAMConfig contains configurations for static IPAM (IP Address Management)", - "addresses": "Addresses configures IP address for the interface", - "routes": "Routes configures IP routes for the interface", - "dns": "DNS configures DNS for the interface", + "addresses": "addresses configures IP address for the interface", + "routes": "routes configures IP routes for the interface", + "dns": "dns configures DNS for the interface", } func (StaticIPAMConfig) SwaggerDoc() map[string]string { @@ -1877,9 +1877,9 @@ func (StaticIPAMConfig) SwaggerDoc() map[string]string { var map_StaticIPAMDNS = map[string]string{ "": "StaticIPAMDNS provides DNS related information for static IPAM", - "nameservers": "Nameservers points DNS servers for IP lookup", - "domain": "Domain configures the domainname the local domain used for short hostname lookups", - "search": "Search configures priority ordered search domains for short hostname lookups", + "nameservers": "nameservers points DNS servers for IP lookup", + "domain": "domain configures the domainname the local domain used for short hostname lookups", + "search": "search configures priority ordered search domains for short hostname lookups", } func (StaticIPAMDNS) SwaggerDoc() map[string]string { @@ -1888,8 +1888,8 @@ func (StaticIPAMDNS) SwaggerDoc() map[string]string { var map_StaticIPAMRoutes = map[string]string{ "": "StaticIPAMRoutes provides Destination/Gateway pairs for static IPAM routes", - "destination": "Destination points the IP route destination", - "gateway": "Gateway is the route's next-hop IP address If unset, a default gateway is assumed (as determined by the CNI plugin).", + "destination": "destination points the IP route destination", + "gateway": "gateway is the route's next-hop IP address If unset, a default gateway is assumed (as determined by the CNI plugin).", } func (StaticIPAMRoutes) SwaggerDoc() map[string]string { @@ -1910,7 +1910,7 @@ func (OLM) SwaggerDoc() map[string]string { var map_OLMList = map[string]string{ "": "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).", "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "items": "Items contains the items", + "items": "items contains the items", } func (OLMList) SwaggerDoc() map[string]string { @@ -1931,7 +1931,7 @@ func (OpenShiftAPIServer) SwaggerDoc() map[string]string { var map_OpenShiftAPIServerList = map[string]string{ "": "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).", "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "items": "Items contains the items", + "items": "items contains the items", } func (OpenShiftAPIServerList) SwaggerDoc() map[string]string { @@ -1950,7 +1950,7 @@ func (OpenShiftControllerManager) SwaggerDoc() map[string]string { var map_OpenShiftControllerManagerList = map[string]string{ "": "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).", "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "items": "Items contains the items", + "items": "items contains the items", } func (OpenShiftControllerManagerList) SwaggerDoc() map[string]string { @@ -1971,7 +1971,7 @@ func (KubeScheduler) SwaggerDoc() map[string]string { var map_KubeSchedulerList = map[string]string{ "": "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).", "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "items": "Items contains the items", + "items": "items contains the items", } func (KubeSchedulerList) SwaggerDoc() map[string]string { @@ -1992,7 +1992,7 @@ func (ServiceCA) SwaggerDoc() map[string]string { var map_ServiceCAList = map[string]string{ "": "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).", "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "items": "Items contains the items", + "items": "items contains the items", } func (ServiceCAList) SwaggerDoc() map[string]string { @@ -2011,7 +2011,7 @@ func (ServiceCatalogAPIServer) SwaggerDoc() map[string]string { var map_ServiceCatalogAPIServerList = map[string]string{ "": "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).", "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "items": "Items contains the items", + "items": "items contains the items", } func (ServiceCatalogAPIServerList) SwaggerDoc() map[string]string { @@ -2030,7 +2030,7 @@ func (ServiceCatalogControllerManager) SwaggerDoc() map[string]string { var map_ServiceCatalogControllerManagerList = map[string]string{ "": "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).", "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "items": "Items contains the items", + "items": "items contains the items", } func (ServiceCatalogControllerManagerList) SwaggerDoc() map[string]string { @@ -2059,7 +2059,7 @@ func (StorageList) SwaggerDoc() map[string]string { var map_StorageSpec = map[string]string{ "": "StorageSpec is the specification of the desired behavior of the cluster storage operator.", - "vsphereStorageDriver": "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.", + "vsphereStorageDriver": "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.", } func (StorageSpec) SwaggerDoc() map[string]string { diff --git a/operator/v1alpha1/types.go b/operator/v1alpha1/types.go index 4d5a207e6aa..932e8c58346 100644 --- a/operator/v1alpha1/types.go +++ b/operator/v1alpha1/types.go @@ -149,7 +149,7 @@ type OperatorStatus struct { type GenericOperatorConfig struct { metav1.TypeMeta `json:",inline"` - // ServingInfo is the HTTP serving information for the controller's endpoints + // servingInfo is the HTTP serving information for the controller's endpoints ServingInfo configv1.HTTPServingInfo `json:"servingInfo,omitempty"` // leaderElection provides information to elect a leader. Only override this if you have a specific need diff --git a/operator/v1alpha1/types_etcdbackup.go b/operator/v1alpha1/types_etcdbackup.go index 2654f570083..3c6f344b1ed 100644 --- a/operator/v1alpha1/types_etcdbackup.go +++ b/operator/v1alpha1/types_etcdbackup.go @@ -23,22 +23,19 @@ type EtcdBackup struct { metav1.ObjectMeta `json:"metadata,omitempty"` // spec holds user settable values for configuration - // +kubebuilder:validation:Required // +required Spec EtcdBackupSpec `json:"spec"` // status holds observed values from the cluster. They may not be overridden. - // +kubebuilder:validation:Optional // +optional Status EtcdBackupStatus `json:"status"` } type EtcdBackupSpec struct { - // PVCName specifies the name of the PersistentVolumeClaim (PVC) which binds a PersistentVolume where the + // 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. - // +kubebuilder:validation:Optional // +optional // +kubebuilder:validation:XValidation:rule="self == oldSelf",message="pvcName is immutable once set" PVCName string `json:"pvcName"` @@ -56,7 +53,7 @@ type EtcdBackupStatus struct { // backupJob is the reference to the Job that executes the backup. // Optional - // +kubebuilder:validation:Optional + // +optional BackupJob *BackupJobReference `json:"backupJob"` } @@ -67,13 +64,13 @@ type BackupJobReference struct { // this is always expected to be "openshift-etcd" since the user provided PVC // is also required to be in "openshift-etcd" // Required - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:Pattern:=`^openshift-etcd$` Namespace string `json:"namespace"` // name is the name of the Job. // Required - // +kubebuilder:validation:Required + // +required Name string `json:"name"` } diff --git a/operator/v1alpha1/types_image_content_source_policy.go b/operator/v1alpha1/types_image_content_source_policy.go index 0830ed7448a..d4f7e17e67c 100644 --- a/operator/v1alpha1/types_image_content_source_policy.go +++ b/operator/v1alpha1/types_image_content_source_policy.go @@ -25,7 +25,6 @@ type ImageContentSourcePolicy struct { metav1.ObjectMeta `json:"metadata,omitempty"` // spec holds user settable values for configuration - // +kubebuilder:validation:Required // +required Spec ImageContentSourcePolicySpec `json:"spec"` } diff --git a/operator/v1alpha1/types_olm.go b/operator/v1alpha1/types_olm.go index 748834ca99d..41d160a2054 100644 --- a/operator/v1alpha1/types_olm.go +++ b/operator/v1alpha1/types_olm.go @@ -31,7 +31,7 @@ type OLM struct { metav1.ObjectMeta `json:"metadata"` //spec holds user settable values for configuration - // +kubebuilder:validation:Required + // +required Spec OLMSpec `json:"spec"` // status holds observed values from the cluster. They may not be overridden. // +optional @@ -59,6 +59,6 @@ type OLMList struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ListMeta `json:"metadata"` - // Items contains the items + // items contains the items Items []OLM `json:"items"` } diff --git a/operator/v1alpha1/zz_generated.crd-manifests/0000_10_etcd_01_etcdbackups-CustomNoUpgrade.crd.yaml b/operator/v1alpha1/zz_generated.crd-manifests/0000_10_etcd_01_etcdbackups-CustomNoUpgrade.crd.yaml index cc2e015c731..49bba6f6cb3 100644 --- a/operator/v1alpha1/zz_generated.crd-manifests/0000_10_etcd_01_etcdbackups-CustomNoUpgrade.crd.yaml +++ b/operator/v1alpha1/zz_generated.crd-manifests/0000_10_etcd_01_etcdbackups-CustomNoUpgrade.crd.yaml @@ -47,7 +47,7 @@ spec: properties: pvcName: description: |- - PVCName specifies the name of the PersistentVolumeClaim (PVC) which binds a PersistentVolume where the + 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. diff --git a/operator/v1alpha1/zz_generated.crd-manifests/0000_10_etcd_01_etcdbackups-DevPreviewNoUpgrade.crd.yaml b/operator/v1alpha1/zz_generated.crd-manifests/0000_10_etcd_01_etcdbackups-DevPreviewNoUpgrade.crd.yaml index 68df34081b9..d015b811ce5 100644 --- a/operator/v1alpha1/zz_generated.crd-manifests/0000_10_etcd_01_etcdbackups-DevPreviewNoUpgrade.crd.yaml +++ b/operator/v1alpha1/zz_generated.crd-manifests/0000_10_etcd_01_etcdbackups-DevPreviewNoUpgrade.crd.yaml @@ -47,7 +47,7 @@ spec: properties: pvcName: description: |- - PVCName specifies the name of the PersistentVolumeClaim (PVC) which binds a PersistentVolume where the + 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. diff --git a/operator/v1alpha1/zz_generated.crd-manifests/0000_10_etcd_01_etcdbackups-TechPreviewNoUpgrade.crd.yaml b/operator/v1alpha1/zz_generated.crd-manifests/0000_10_etcd_01_etcdbackups-TechPreviewNoUpgrade.crd.yaml index 0bb78ad6d88..9d56894fdbb 100644 --- a/operator/v1alpha1/zz_generated.crd-manifests/0000_10_etcd_01_etcdbackups-TechPreviewNoUpgrade.crd.yaml +++ b/operator/v1alpha1/zz_generated.crd-manifests/0000_10_etcd_01_etcdbackups-TechPreviewNoUpgrade.crd.yaml @@ -47,7 +47,7 @@ spec: properties: pvcName: description: |- - PVCName specifies the name of the PersistentVolumeClaim (PVC) which binds a PersistentVolume where the + 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. diff --git a/operator/v1alpha1/zz_generated.featuregated-crd-manifests/etcdbackups.operator.openshift.io/AutomatedEtcdBackup.yaml b/operator/v1alpha1/zz_generated.featuregated-crd-manifests/etcdbackups.operator.openshift.io/AutomatedEtcdBackup.yaml index de4f585d29d..07becf7e251 100644 --- a/operator/v1alpha1/zz_generated.featuregated-crd-manifests/etcdbackups.operator.openshift.io/AutomatedEtcdBackup.yaml +++ b/operator/v1alpha1/zz_generated.featuregated-crd-manifests/etcdbackups.operator.openshift.io/AutomatedEtcdBackup.yaml @@ -47,7 +47,7 @@ spec: properties: pvcName: description: |- - PVCName specifies the name of the PersistentVolumeClaim (PVC) which binds a PersistentVolume where the + 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. diff --git a/operator/v1alpha1/zz_generated.swagger_doc_generated.go b/operator/v1alpha1/zz_generated.swagger_doc_generated.go index c8cce688f4c..9a45dbd04a1 100644 --- a/operator/v1alpha1/zz_generated.swagger_doc_generated.go +++ b/operator/v1alpha1/zz_generated.swagger_doc_generated.go @@ -44,7 +44,7 @@ func (GenerationHistory) SwaggerDoc() map[string]string { var map_GenericOperatorConfig = map[string]string{ "": "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.", - "servingInfo": "ServingInfo is the HTTP serving information for the controller's endpoints", + "servingInfo": "servingInfo is the HTTP serving information for the controller's endpoints", "leaderElection": "leaderElection provides information to elect a leader. Only override this if you have a specific need", "authentication": "authentication allows configuration of authentication for the endpoints", "authorization": "authorization allows configuration of authentication for the endpoints", @@ -164,7 +164,7 @@ func (EtcdBackupList) SwaggerDoc() map[string]string { } var map_EtcdBackupSpec = map[string]string{ - "pvcName": "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.", + "pvcName": "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.", } func (EtcdBackupSpec) SwaggerDoc() map[string]string { @@ -232,7 +232,7 @@ func (OLM) SwaggerDoc() map[string]string { var map_OLMList = map[string]string{ "": "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.", "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "items": "Items contains the items", + "items": "items contains the items", } func (OLMList) SwaggerDoc() map[string]string { diff --git a/operatorcontrolplane/v1alpha1/types_conditioncheck.go b/operatorcontrolplane/v1alpha1/types_conditioncheck.go index f4b48e8545a..7b4ac19f7fa 100644 --- a/operatorcontrolplane/v1alpha1/types_conditioncheck.go +++ b/operatorcontrolplane/v1alpha1/types_conditioncheck.go @@ -26,19 +26,17 @@ type PodNetworkConnectivityCheck struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata"` - // Spec defines the source and target of the connectivity check - // +kubebuilder:validation:Required + // spec defines the source and target of the connectivity check // +required Spec PodNetworkConnectivityCheckSpec `json:"spec"` - // Status contains the observed status of the connectivity check + // status contains the observed status of the connectivity check // +optional Status PodNetworkConnectivityCheckStatus `json:"status,omitempty"` } type PodNetworkConnectivityCheckSpec struct { - // SourcePod names the pod from which the condition will be checked - // +kubebuilder:validation:Required + // sourcePod names the pod from which the condition will be checked // +kubebuilder:validation:Pattern=`^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$` // +required SourcePod string `json:"sourcePod"` @@ -46,7 +44,6 @@ type PodNetworkConnectivityCheckSpec struct { // 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. - // +kubebuilder:validation:Required // +kubebuilder:validation:Pattern=`^\S+:\d*$` // +required TargetEndpoint string `json:"targetEndpoint"` @@ -62,19 +59,19 @@ type PodNetworkConnectivityCheckSpec struct { // +k8s:deepcopy-gen=true type PodNetworkConnectivityCheckStatus struct { - // Successes contains logs successful check actions + // successes contains logs successful check actions // +optional Successes []LogEntry `json:"successes,omitempty"` - // Failures contains logs of unsuccessful check actions + // failures contains logs of unsuccessful check actions // +optional Failures []LogEntry `json:"failures,omitempty"` - // Outages contains logs of time periods of outages + // outages contains logs of time periods of outages // +optional Outages []OutageEntry `json:"outages,omitempty"` - // Conditions summarize the status of the check + // conditions summarize the status of the check // +patchMergeKey=type // +patchStrategy=merge // +optional @@ -84,25 +81,23 @@ type PodNetworkConnectivityCheckStatus struct { // LogEntry records events type LogEntry struct { // Start time of check action. - // +kubebuilder:validation:Required // +required // +nullable Start metav1.Time `json:"time"` - // Success indicates if the log entry indicates a success or failure. - // +kubebuilder:validation:Required + // success indicates if the log entry indicates a success or failure. // +required Success bool `json:"success"` - // Reason for status in a machine readable format. + // reason for status in a machine readable format. // +optional Reason string `json:"reason,omitempty"` - // Message explaining status in a human readable format. + // message explaining status in a human readable format. // +optional Message string `json:"message,omitempty"` - // Latency records how long the action mentioned in the entry took. + // latency records how long the action mentioned in the entry took. // +optional // +nullable Latency metav1.Duration `json:"latency,omitempty"` @@ -111,23 +106,22 @@ type LogEntry struct { // OutageEntry records time period of an outage type OutageEntry struct { - // Start of outage detected - // +kubebuilder:validation:Required + // start of outage detected // +required // +nullable Start metav1.Time `json:"start"` - // End of outage detected + // end of outage detected // +optional // +nullable End metav1.Time `json:"end,omitempty"` - // StartLogs contains log entries related to the start of this outage. Should contain + // startLogs contains log entries related to the start of this outage. Should contain // the original failure, any entries where the failure mode changed. // +optional StartLogs []LogEntry `json:"startLogs,omitempty"` - // EndLogs contains log entries related to the end of this outage. Should contain the success + // 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. // +optional EndLogs []LogEntry `json:"endLogs,omitempty"` @@ -142,12 +136,10 @@ type OutageEntry struct { type PodNetworkConnectivityCheckCondition struct { // Type of the condition - // +kubebuilder:validation:Required // +required Type PodNetworkConnectivityCheckConditionType `json:"type"` // Status of the condition - // +kubebuilder:validation:Required // +required Status metav1.ConditionStatus `json:"status"` @@ -160,7 +152,6 @@ type PodNetworkConnectivityCheckCondition struct { Message string `json:"message,omitempty"` // Last time the condition transitioned from one status to another. - // +kubebuilder:validation:Required // +required // +nullable LastTransitionTime metav1.Time `json:"lastTransitionTime"` diff --git a/operatorcontrolplane/v1alpha1/zz_generated.crd-manifests/0000_10_network_01_podnetworkconnectivitychecks.crd.yaml b/operatorcontrolplane/v1alpha1/zz_generated.crd-manifests/0000_10_network_01_podnetworkconnectivitychecks.crd.yaml index 6cef9373583..decc9dabeb0 100644 --- a/operatorcontrolplane/v1alpha1/zz_generated.crd-manifests/0000_10_network_01_podnetworkconnectivitychecks.crd.yaml +++ b/operatorcontrolplane/v1alpha1/zz_generated.crd-manifests/0000_10_network_01_podnetworkconnectivitychecks.crd.yaml @@ -41,10 +41,10 @@ spec: metadata: type: object spec: - description: Spec defines the source and target of the connectivity check + description: spec defines the source and target of the connectivity check properties: sourcePod: - description: SourcePod names the pod from which the condition will + description: sourcePod names the pod from which the condition will be checked pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$ type: string @@ -74,10 +74,10 @@ spec: - targetEndpoint type: object status: - description: Status contains the observed status of the connectivity check + description: status contains the observed status of the connectivity check properties: conditions: - description: Conditions summarize the status of the check + description: conditions summarize the status of the check items: description: PodNetworkConnectivityCheckCondition represents the overall status of the pod network connectivity. @@ -109,23 +109,23 @@ spec: type: object type: array failures: - description: Failures contains logs of unsuccessful check actions + description: failures contains logs of unsuccessful check actions items: description: LogEntry records events properties: latency: - description: Latency records how long the action mentioned in + description: latency records how long the action mentioned in the entry took. nullable: true type: string message: - description: Message explaining status in a human readable format. + description: message explaining status in a human readable format. type: string reason: - description: Reason for status in a machine readable format. + description: reason for status in a machine readable format. type: string success: - description: Success indicates if the log entry indicates a + description: success indicates if the log entry indicates a success or failure. type: boolean time: @@ -139,36 +139,36 @@ spec: type: object type: array outages: - description: Outages contains logs of time periods of outages + description: outages contains logs of time periods of outages items: description: OutageEntry records time period of an outage properties: end: - description: End of outage detected + description: end of outage detected format: date-time nullable: true type: string endLogs: description: |- - EndLogs contains log entries related to the end of this outage. Should contain the success + 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: description: LogEntry records events properties: latency: - description: Latency records how long the action mentioned + description: latency records how long the action mentioned in the entry took. nullable: true type: string message: - description: Message explaining status in a human readable + description: message explaining status in a human readable format. type: string reason: - description: Reason for status in a machine readable format. + description: reason for status in a machine readable format. type: string success: - description: Success indicates if the log entry indicates + description: success indicates if the log entry indicates a success or failure. type: boolean time: @@ -186,31 +186,31 @@ spec: format. type: string start: - description: Start of outage detected + description: start of outage detected format: date-time nullable: true type: string startLogs: description: |- - StartLogs contains log entries related to the start of this outage. Should contain + startLogs contains log entries related to the start of this outage. Should contain the original failure, any entries where the failure mode changed. items: description: LogEntry records events properties: latency: - description: Latency records how long the action mentioned + description: latency records how long the action mentioned in the entry took. nullable: true type: string message: - description: Message explaining status in a human readable + description: message explaining status in a human readable format. type: string reason: - description: Reason for status in a machine readable format. + description: reason for status in a machine readable format. type: string success: - description: Success indicates if the log entry indicates + description: success indicates if the log entry indicates a success or failure. type: boolean time: @@ -228,23 +228,23 @@ spec: type: object type: array successes: - description: Successes contains logs successful check actions + description: successes contains logs successful check actions items: description: LogEntry records events properties: latency: - description: Latency records how long the action mentioned in + description: latency records how long the action mentioned in the entry took. nullable: true type: string message: - description: Message explaining status in a human readable format. + description: message explaining status in a human readable format. type: string reason: - description: Reason for status in a machine readable format. + description: reason for status in a machine readable format. type: string success: - description: Success indicates if the log entry indicates a + description: success indicates if the log entry indicates a success or failure. type: boolean time: diff --git a/operatorcontrolplane/v1alpha1/zz_generated.featuregated-crd-manifests/podnetworkconnectivitychecks.controlplane.operator.openshift.io/AAA_ungated.yaml b/operatorcontrolplane/v1alpha1/zz_generated.featuregated-crd-manifests/podnetworkconnectivitychecks.controlplane.operator.openshift.io/AAA_ungated.yaml index f1631f6179e..bad9d763b13 100644 --- a/operatorcontrolplane/v1alpha1/zz_generated.featuregated-crd-manifests/podnetworkconnectivitychecks.controlplane.operator.openshift.io/AAA_ungated.yaml +++ b/operatorcontrolplane/v1alpha1/zz_generated.featuregated-crd-manifests/podnetworkconnectivitychecks.controlplane.operator.openshift.io/AAA_ungated.yaml @@ -44,10 +44,10 @@ spec: metadata: type: object spec: - description: Spec defines the source and target of the connectivity check + description: spec defines the source and target of the connectivity check properties: sourcePod: - description: SourcePod names the pod from which the condition will + description: sourcePod names the pod from which the condition will be checked pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$ type: string @@ -77,10 +77,10 @@ spec: - targetEndpoint type: object status: - description: Status contains the observed status of the connectivity check + description: status contains the observed status of the connectivity check properties: conditions: - description: Conditions summarize the status of the check + description: conditions summarize the status of the check items: description: PodNetworkConnectivityCheckCondition represents the overall status of the pod network connectivity. @@ -112,23 +112,23 @@ spec: type: object type: array failures: - description: Failures contains logs of unsuccessful check actions + description: failures contains logs of unsuccessful check actions items: description: LogEntry records events properties: latency: - description: Latency records how long the action mentioned in + description: latency records how long the action mentioned in the entry took. nullable: true type: string message: - description: Message explaining status in a human readable format. + description: message explaining status in a human readable format. type: string reason: - description: Reason for status in a machine readable format. + description: reason for status in a machine readable format. type: string success: - description: Success indicates if the log entry indicates a + description: success indicates if the log entry indicates a success or failure. type: boolean time: @@ -142,36 +142,36 @@ spec: type: object type: array outages: - description: Outages contains logs of time periods of outages + description: outages contains logs of time periods of outages items: description: OutageEntry records time period of an outage properties: end: - description: End of outage detected + description: end of outage detected format: date-time nullable: true type: string endLogs: description: |- - EndLogs contains log entries related to the end of this outage. Should contain the success + 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: description: LogEntry records events properties: latency: - description: Latency records how long the action mentioned + description: latency records how long the action mentioned in the entry took. nullable: true type: string message: - description: Message explaining status in a human readable + description: message explaining status in a human readable format. type: string reason: - description: Reason for status in a machine readable format. + description: reason for status in a machine readable format. type: string success: - description: Success indicates if the log entry indicates + description: success indicates if the log entry indicates a success or failure. type: boolean time: @@ -189,31 +189,31 @@ spec: format. type: string start: - description: Start of outage detected + description: start of outage detected format: date-time nullable: true type: string startLogs: description: |- - StartLogs contains log entries related to the start of this outage. Should contain + startLogs contains log entries related to the start of this outage. Should contain the original failure, any entries where the failure mode changed. items: description: LogEntry records events properties: latency: - description: Latency records how long the action mentioned + description: latency records how long the action mentioned in the entry took. nullable: true type: string message: - description: Message explaining status in a human readable + description: message explaining status in a human readable format. type: string reason: - description: Reason for status in a machine readable format. + description: reason for status in a machine readable format. type: string success: - description: Success indicates if the log entry indicates + description: success indicates if the log entry indicates a success or failure. type: boolean time: @@ -231,23 +231,23 @@ spec: type: object type: array successes: - description: Successes contains logs successful check actions + description: successes contains logs successful check actions items: description: LogEntry records events properties: latency: - description: Latency records how long the action mentioned in + description: latency records how long the action mentioned in the entry took. nullable: true type: string message: - description: Message explaining status in a human readable format. + description: message explaining status in a human readable format. type: string reason: - description: Reason for status in a machine readable format. + description: reason for status in a machine readable format. type: string success: - description: Success indicates if the log entry indicates a + description: success indicates if the log entry indicates a success or failure. type: boolean time: diff --git a/operatorcontrolplane/v1alpha1/zz_generated.swagger_doc_generated.go b/operatorcontrolplane/v1alpha1/zz_generated.swagger_doc_generated.go index 5ecc5e48af7..50d086d3337 100644 --- a/operatorcontrolplane/v1alpha1/zz_generated.swagger_doc_generated.go +++ b/operatorcontrolplane/v1alpha1/zz_generated.swagger_doc_generated.go @@ -14,10 +14,10 @@ package v1alpha1 var map_LogEntry = map[string]string{ "": "LogEntry records events", "time": "Start time of check action.", - "success": "Success indicates if the log entry indicates a success or failure.", - "reason": "Reason for status in a machine readable format.", - "message": "Message explaining status in a human readable format.", - "latency": "Latency records how long the action mentioned in the entry took.", + "success": "success indicates if the log entry indicates a success or failure.", + "reason": "reason for status in a machine readable format.", + "message": "message explaining status in a human readable format.", + "latency": "latency records how long the action mentioned in the entry took.", } func (LogEntry) SwaggerDoc() map[string]string { @@ -26,10 +26,10 @@ func (LogEntry) SwaggerDoc() map[string]string { var map_OutageEntry = map[string]string{ "": "OutageEntry records time period of an outage", - "start": "Start of outage detected", - "end": "End of outage detected", - "startLogs": "StartLogs contains log entries related to the start of this outage. Should contain the original failure, any entries where the failure mode changed.", - "endLogs": "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.", + "start": "start of outage detected", + "end": "end of outage detected", + "startLogs": "startLogs contains log entries related to the start of this outage. Should contain the original failure, any entries where the failure mode changed.", + "endLogs": "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.", "message": "Message summarizes outage details in a human readable format.", } @@ -40,8 +40,8 @@ func (OutageEntry) SwaggerDoc() map[string]string { var map_PodNetworkConnectivityCheck = map[string]string{ "": "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.", "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "spec": "Spec defines the source and target of the connectivity check", - "status": "Status contains the observed status of the connectivity check", + "spec": "spec defines the source and target of the connectivity check", + "status": "status contains the observed status of the connectivity check", } func (PodNetworkConnectivityCheck) SwaggerDoc() map[string]string { @@ -72,7 +72,7 @@ func (PodNetworkConnectivityCheckList) SwaggerDoc() map[string]string { } var map_PodNetworkConnectivityCheckSpec = map[string]string{ - "sourcePod": "SourcePod names the pod from which the condition will be checked", + "sourcePod": "sourcePod names the pod from which the condition will be checked", "targetEndpoint": "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.", "tlsClientCert": "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.", } @@ -82,10 +82,10 @@ func (PodNetworkConnectivityCheckSpec) SwaggerDoc() map[string]string { } var map_PodNetworkConnectivityCheckStatus = map[string]string{ - "successes": "Successes contains logs successful check actions", - "failures": "Failures contains logs of unsuccessful check actions", - "outages": "Outages contains logs of time periods of outages", - "conditions": "Conditions summarize the status of the check", + "successes": "successes contains logs successful check actions", + "failures": "failures contains logs of unsuccessful check actions", + "outages": "outages contains logs of time periods of outages", + "conditions": "conditions summarize the status of the check", } func (PodNetworkConnectivityCheckStatus) SwaggerDoc() map[string]string { diff --git a/operatoringress/v1/types.go b/operatoringress/v1/types.go index c4bee5c74f6..a50d1148e5c 100644 --- a/operatoringress/v1/types.go +++ b/operatoringress/v1/types.go @@ -43,25 +43,21 @@ type DNSRecord struct { type DNSRecordSpec struct { // dnsName is the hostname of the DNS record // - // +kubebuilder:validation:Required // +kubebuilder:validation:MinLength=1 // +required DNSName string `json:"dnsName"` // targets are record targets. // - // +kubebuilder:validation:Required // +kubebuilder:validation:MinItems=1 // +required Targets []string `json:"targets"` // recordType is the DNS record type. For example, "A" or "CNAME". - // +kubebuilder:validation:Required // +required RecordType DNSRecordType `json:"recordType"` // 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. // - // +kubebuilder:validation:Required // +kubebuilder:validation:Minimum=0 // +required RecordTTL int64 `json:"recordTTL"` @@ -77,7 +73,7 @@ type DNSRecordSpec struct { // "Unmanaged". // // +kubebuilder:default:="Managed" - // +kubebuilder:validation:Required + // +required // +default="Managed" DNSManagementPolicy DNSManagementPolicy `json:"dnsManagementPolicy,omitempty"` } @@ -120,11 +116,9 @@ var ( // DNSZoneCondition is just the standard condition fields. type DNSZoneCondition struct { - // +kubebuilder:validation:Required // +kubebuilder:validation:MinLength=1 // +required Type string `json:"type"` - // +kubebuilder:validation:Required // +kubebuilder:validation:MinLength=1 // +required Status string `json:"status"` diff --git a/osin/v1/types.go b/osin/v1/types.go index 0ea4be1ba0f..35eb3ee8b01 100644 --- a/osin/v1/types.go +++ b/osin/v1/types.go @@ -473,7 +473,7 @@ type TokenConfig struct { type SessionSecrets struct { metav1.TypeMeta `json:",inline"` - // Secrets is a list of secrets + // 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. Secrets []SessionSecret `json:"secrets"` @@ -481,8 +481,8 @@ type SessionSecrets struct { // SessionSecret is a secret used to authenticate/decrypt cookie-based sessions type SessionSecret struct { - // Authentication is used to authenticate sessions using HMAC. Recommended to use a secret with 32 or 64 bytes. + // authentication is used to authenticate sessions using HMAC. Recommended to use a secret with 32 or 64 bytes. Authentication string `json:"authentication"` - // Encryption is used to encrypt sessions. Must be 16, 24, or 32 characters long, to select AES-128, AES- + // encryption is used to encrypt sessions. Must be 16, 24, or 32 characters long, to select AES-128, AES- Encryption string `json:"encryption"` } diff --git a/osin/v1/zz_generated.swagger_doc_generated.go b/osin/v1/zz_generated.swagger_doc_generated.go index 0bffa8265b7..890928a7a4d 100644 --- a/osin/v1/zz_generated.swagger_doc_generated.go +++ b/osin/v1/zz_generated.swagger_doc_generated.go @@ -248,8 +248,8 @@ func (SessionConfig) SwaggerDoc() map[string]string { var map_SessionSecret = map[string]string{ "": "SessionSecret is a secret used to authenticate/decrypt cookie-based sessions", - "authentication": "Authentication is used to authenticate sessions using HMAC. Recommended to use a secret with 32 or 64 bytes.", - "encryption": "Encryption is used to encrypt sessions. Must be 16, 24, or 32 characters long, to select AES-128, AES-", + "authentication": "authentication is used to authenticate sessions using HMAC. Recommended to use a secret with 32 or 64 bytes.", + "encryption": "encryption is used to encrypt sessions. Must be 16, 24, or 32 characters long, to select AES-128, AES-", } func (SessionSecret) SwaggerDoc() map[string]string { @@ -258,7 +258,7 @@ func (SessionSecret) SwaggerDoc() map[string]string { var map_SessionSecrets = map[string]string{ "": "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.", - "secrets": "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.", + "secrets": "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.", } func (SessionSecrets) SwaggerDoc() map[string]string { diff --git a/payload-manifests/crds/0000_03_config-operator_01_clusterresourcequotas.crd.yaml b/payload-manifests/crds/0000_03_config-operator_01_clusterresourcequotas.crd.yaml index 862365b6727..fe6e1217312 100644 --- a/payload-manifests/crds/0000_03_config-operator_01_clusterresourcequotas.crd.yaml +++ b/payload-manifests/crds/0000_03_config-operator_01_clusterresourcequotas.crd.yaml @@ -44,10 +44,10 @@ spec: metadata: type: object spec: - description: Spec defines the desired quota + description: spec defines the desired quota properties: quota: - description: Quota defines the desired quota + description: quota defines the desired quota properties: hard: additionalProperties: @@ -114,7 +114,7 @@ spec: type: object selector: description: |- - Selector is the selector used to match projects. + 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. @@ -179,12 +179,12 @@ spec: - selector type: object status: - description: Status defines the actual enforced quota and its current + description: status defines the actual enforced quota and its current usage properties: namespaces: description: |- - Namespaces slices the usage by project. This division allows for quick resolution of + 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. items: @@ -192,10 +192,10 @@ spec: project properties: namespace: - description: Namespace the project this status applies to + description: namespace the project this status applies to type: string status: - description: Status indicates how many resources have been consumed + description: status indicates how many resources have been consumed by this project properties: hard: @@ -227,7 +227,7 @@ spec: nullable: true type: array total: - description: Total defines the actual enforced quota and its current + description: total defines the actual enforced quota and its current usage across all projects properties: hard: diff --git a/payload-manifests/crds/0000_03_config-operator_01_proxies.crd.yaml b/payload-manifests/crds/0000_03_config-operator_01_proxies.crd.yaml index b774262cd02..99ea9d49cca 100644 --- a/payload-manifests/crds/0000_03_config-operator_01_proxies.crd.yaml +++ b/payload-manifests/crds/0000_03_config-operator_01_proxies.crd.yaml @@ -43,7 +43,7 @@ spec: metadata: type: object spec: - description: Spec holds user-settable values for the proxy configuration + description: spec holds user-settable values for the proxy configuration properties: httpProxy: description: httpProxy is the URL of the proxy for HTTP requests. Empty diff --git a/payload-manifests/crds/0000_03_config-operator_01_rolebindingrestrictions.crd.yaml b/payload-manifests/crds/0000_03_config-operator_01_rolebindingrestrictions.crd.yaml index c5c8dc8fdce..275e90aeec0 100644 --- a/payload-manifests/crds/0000_03_config-operator_01_rolebindingrestrictions.crd.yaml +++ b/payload-manifests/crds/0000_03_config-operator_01_rolebindingrestrictions.crd.yaml @@ -47,15 +47,15 @@ spec: metadata: type: object spec: - description: Spec defines the matcher. + description: spec defines the matcher. properties: grouprestriction: - description: GroupRestriction matches against group subjects. + description: grouprestriction matches against group subjects. nullable: true properties: groups: description: |- - Groups is a list of groups used to match against an individual user's + 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. items: @@ -118,18 +118,18 @@ spec: type: array type: object serviceaccountrestriction: - description: ServiceAccountRestriction matches against service-account + description: serviceaccountrestriction matches against service-account subjects. nullable: true properties: namespaces: - description: Namespaces specifies a list of literal namespace + description: namespaces specifies a list of literal namespace names. items: type: string type: array serviceaccounts: - description: ServiceAccounts specifies a list of literal service-account + description: serviceaccounts specifies a list of literal service-account names. items: description: |- @@ -137,11 +137,11 @@ spec: names. properties: name: - description: Name is the name of the service account. + description: name is the name of the service account. type: string namespace: description: |- - Namespace is the namespace of the service account. Service accounts from + 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. @@ -150,11 +150,11 @@ spec: type: array type: object userrestriction: - description: UserRestriction matches against user subjects. + description: userrestriction matches against user subjects. nullable: true properties: groups: - description: Groups specifies a list of literal group names. + description: groups specifies a list of literal group names. items: type: string nullable: true @@ -214,7 +214,7 @@ spec: nullable: true type: array users: - description: Users specifies a list of literal user names. + description: users specifies a list of literal user names. items: type: string type: array diff --git a/payload-manifests/crds/0000_03_config-operator_01_securitycontextconstraints-CustomNoUpgrade.crd.yaml b/payload-manifests/crds/0000_03_config-operator_01_securitycontextconstraints-CustomNoUpgrade.crd.yaml index 853e6e331a7..9c7cb41f64a 100644 --- a/payload-manifests/crds/0000_03_config-operator_01_securitycontextconstraints-CustomNoUpgrade.crd.yaml +++ b/payload-manifests/crds/0000_03_config-operator_01_securitycontextconstraints-CustomNoUpgrade.crd.yaml @@ -70,38 +70,38 @@ spec: Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). properties: allowHostDirVolumePlugin: - description: AllowHostDirVolumePlugin determines if the policy allow containers + description: allowHostDirVolumePlugin determines if the policy allow containers to use the HostDir volume plugin type: boolean allowHostIPC: - description: AllowHostIPC determines if the policy allows host ipc in + description: allowHostIPC determines if the policy allows host ipc in the containers. type: boolean allowHostNetwork: - description: AllowHostNetwork determines if the policy allows the use + description: allowHostNetwork determines if the policy allows the use of HostNetwork in the pod spec. type: boolean allowHostPID: - description: AllowHostPID determines if the policy allows host pid in + description: allowHostPID determines if the policy allows host pid in the containers. type: boolean allowHostPorts: - description: AllowHostPorts determines if the policy allows host ports + description: allowHostPorts determines if the policy allows host ports in the containers. type: boolean allowPrivilegeEscalation: description: |- - AllowPrivilegeEscalation determines if a pod can request to allow + allowPrivilegeEscalation determines if a pod can request to allow privilege escalation. If unspecified, defaults to true. nullable: true type: boolean allowPrivilegedContainer: - description: AllowPrivilegedContainer determines if a container can request + description: allowPrivilegedContainer determines if a container can request to be run as privileged. type: boolean allowedCapabilities: description: |- - AllowedCapabilities is a list of capabilities that can be requested to add to the container. + 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 '*'. @@ -113,7 +113,7 @@ spec: x-kubernetes-list-type: atomic allowedFlexVolumes: description: |- - AllowedFlexVolumes is a whitelist of allowed Flexvolumes. Empty or nil indicates that all + 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. items: @@ -121,7 +121,7 @@ spec: allowed to be used. properties: driver: - description: Driver is the name of the Flexvolume driver. + description: driver is the name of the Flexvolume driver. type: string required: - driver @@ -131,7 +131,7 @@ spec: x-kubernetes-list-type: atomic allowedUnsafeSysctls: description: |- - AllowedUnsafeSysctls is a list of explicitly allowed unsafe sysctls, defaults to none. + 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. @@ -153,7 +153,7 @@ spec: type: string defaultAddCapabilities: description: |- - DefaultAddCapabilities is the default set of capabilities that will be added to the container + 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. items: @@ -164,13 +164,13 @@ spec: x-kubernetes-list-type: atomic defaultAllowPrivilegeEscalation: description: |- - DefaultAllowPrivilegeEscalation controls the default setting for whether a + defaultAllowPrivilegeEscalation controls the default setting for whether a process can gain more privileges than its parent process. nullable: true type: boolean forbiddenSysctls: description: |- - ForbiddenSysctls is a list of explicitly forbidden sysctls, defaults to none. + 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. @@ -183,30 +183,30 @@ spec: type: array x-kubernetes-list-type: atomic fsGroup: - description: FSGroup is the strategy that will dictate what fs group is + description: fsGroup is the strategy that will dictate what fs group is used by the SecurityContext. nullable: true properties: ranges: description: |- - Ranges are the allowed ranges of fs groups. If you would like to force a single + 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. items: description: IDRange provides a min/max of an allowed range of IDs. properties: max: - description: Max is the end of the range, inclusive. + description: max is the end of the range, inclusive. format: int64 type: integer min: - description: Min is the start of the range, inclusive. + description: min is the start of the range, inclusive. format: int64 type: integer type: object type: array x-kubernetes-list-type: atomic type: - description: Type is the strategy that will dictate what FSGroup is + description: type is the strategy that will dictate what FSGroup is used in the SecurityContext. type: string type: object @@ -230,7 +230,7 @@ spec: type: object priority: description: |- - Priority influences the sort order of SCCs when evaluating which SCCs to try first for + 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 @@ -241,7 +241,7 @@ spec: type: integer readOnlyRootFilesystem: description: |- - ReadOnlyRootFilesystem when set to true will force containers to run with a read only root file + 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 @@ -249,7 +249,7 @@ spec: type: boolean requiredDropCapabilities: description: |- - RequiredDropCapabilities are the capabilities that will be dropped from the container. These + requiredDropCapabilities are the capabilities that will be dropped from the container. These are required to be dropped and cannot be added. items: description: Capability represent POSIX capabilities type @@ -258,33 +258,33 @@ spec: type: array x-kubernetes-list-type: atomic runAsUser: - description: RunAsUser is the strategy that will dictate what RunAsUser + description: runAsUser is the strategy that will dictate what RunAsUser is used in the SecurityContext. nullable: true properties: type: - description: Type is the strategy that will dictate what RunAsUser + description: type is the strategy that will dictate what RunAsUser is used in the SecurityContext. type: string uid: description: |- - UID is the user id that containers must run as. Required for the MustRunAs strategy if not using + uid is the user id that containers must run as. Required for the MustRunAs strategy if not using namespace/service account allocated uids. format: int64 type: integer uidRangeMax: - description: UIDRangeMax defines the max value for a strategy that + description: uidRangeMax defines the max value for a strategy that allocates by range. format: int64 type: integer uidRangeMin: - description: UIDRangeMin defines the min value for a strategy that + description: uidRangeMin defines the min value for a strategy that allocates by range. format: int64 type: integer type: object seLinuxContext: - description: SELinuxContext is the strategy that will dictate what labels + description: seLinuxContext is the strategy that will dictate what labels will be set in the SecurityContext. nullable: true properties: @@ -309,12 +309,12 @@ spec: type: string type: object type: - description: Type is the strategy that will dictate what SELinux context + description: type is the strategy that will dictate what SELinux context is used in the SecurityContext. type: string type: object seccompProfiles: - description: "SeccompProfiles lists the allowed profiles that may be set + description: "seccompProfiles lists the allowed profiles that may be set for the pod or\ncontainer's seccomp annotations. An unset (nil) or empty value means that no profiles may\nbe specifid by the pod or container.\tThe wildcard '*' may be used to allow all profiles. When\nused to generate @@ -326,30 +326,30 @@ spec: type: array x-kubernetes-list-type: atomic supplementalGroups: - description: SupplementalGroups is the strategy that will dictate what + description: supplementalGroups is the strategy that will dictate what supplemental groups are used by the SecurityContext. nullable: true properties: ranges: description: |- - Ranges are the allowed ranges of supplemental groups. If you would like to force a single + 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. items: description: IDRange provides a min/max of an allowed range of IDs. properties: max: - description: Max is the end of the range, inclusive. + description: max is the end of the range, inclusive. format: int64 type: integer min: - description: Min is the start of the range, inclusive. + description: min is the start of the range, inclusive. format: int64 type: integer type: object type: array x-kubernetes-list-type: atomic type: - description: Type is the strategy that will dictate what supplemental + description: type is the strategy that will dictate what supplemental groups is used in the SecurityContext. type: string type: object @@ -375,7 +375,7 @@ spec: x-kubernetes-list-type: atomic volumes: description: |- - Volumes is a white list of allowed volume plugins. FSType corresponds directly with the field names + 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"]. items: diff --git a/payload-manifests/crds/0000_03_config-operator_01_securitycontextconstraints-Default.crd.yaml b/payload-manifests/crds/0000_03_config-operator_01_securitycontextconstraints-Default.crd.yaml index 9064d78d913..2d171c6d853 100644 --- a/payload-manifests/crds/0000_03_config-operator_01_securitycontextconstraints-Default.crd.yaml +++ b/payload-manifests/crds/0000_03_config-operator_01_securitycontextconstraints-Default.crd.yaml @@ -70,38 +70,38 @@ spec: Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). properties: allowHostDirVolumePlugin: - description: AllowHostDirVolumePlugin determines if the policy allow containers + description: allowHostDirVolumePlugin determines if the policy allow containers to use the HostDir volume plugin type: boolean allowHostIPC: - description: AllowHostIPC determines if the policy allows host ipc in + description: allowHostIPC determines if the policy allows host ipc in the containers. type: boolean allowHostNetwork: - description: AllowHostNetwork determines if the policy allows the use + description: allowHostNetwork determines if the policy allows the use of HostNetwork in the pod spec. type: boolean allowHostPID: - description: AllowHostPID determines if the policy allows host pid in + description: allowHostPID determines if the policy allows host pid in the containers. type: boolean allowHostPorts: - description: AllowHostPorts determines if the policy allows host ports + description: allowHostPorts determines if the policy allows host ports in the containers. type: boolean allowPrivilegeEscalation: description: |- - AllowPrivilegeEscalation determines if a pod can request to allow + allowPrivilegeEscalation determines if a pod can request to allow privilege escalation. If unspecified, defaults to true. nullable: true type: boolean allowPrivilegedContainer: - description: AllowPrivilegedContainer determines if a container can request + description: allowPrivilegedContainer determines if a container can request to be run as privileged. type: boolean allowedCapabilities: description: |- - AllowedCapabilities is a list of capabilities that can be requested to add to the container. + 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 '*'. @@ -113,7 +113,7 @@ spec: x-kubernetes-list-type: atomic allowedFlexVolumes: description: |- - AllowedFlexVolumes is a whitelist of allowed Flexvolumes. Empty or nil indicates that all + 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. items: @@ -121,7 +121,7 @@ spec: allowed to be used. properties: driver: - description: Driver is the name of the Flexvolume driver. + description: driver is the name of the Flexvolume driver. type: string required: - driver @@ -131,7 +131,7 @@ spec: x-kubernetes-list-type: atomic allowedUnsafeSysctls: description: |- - AllowedUnsafeSysctls is a list of explicitly allowed unsafe sysctls, defaults to none. + 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. @@ -153,7 +153,7 @@ spec: type: string defaultAddCapabilities: description: |- - DefaultAddCapabilities is the default set of capabilities that will be added to the container + 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. items: @@ -164,13 +164,13 @@ spec: x-kubernetes-list-type: atomic defaultAllowPrivilegeEscalation: description: |- - DefaultAllowPrivilegeEscalation controls the default setting for whether a + defaultAllowPrivilegeEscalation controls the default setting for whether a process can gain more privileges than its parent process. nullable: true type: boolean forbiddenSysctls: description: |- - ForbiddenSysctls is a list of explicitly forbidden sysctls, defaults to none. + 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. @@ -183,30 +183,30 @@ spec: type: array x-kubernetes-list-type: atomic fsGroup: - description: FSGroup is the strategy that will dictate what fs group is + description: fsGroup is the strategy that will dictate what fs group is used by the SecurityContext. nullable: true properties: ranges: description: |- - Ranges are the allowed ranges of fs groups. If you would like to force a single + 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. items: description: IDRange provides a min/max of an allowed range of IDs. properties: max: - description: Max is the end of the range, inclusive. + description: max is the end of the range, inclusive. format: int64 type: integer min: - description: Min is the start of the range, inclusive. + description: min is the start of the range, inclusive. format: int64 type: integer type: object type: array x-kubernetes-list-type: atomic type: - description: Type is the strategy that will dictate what FSGroup is + description: type is the strategy that will dictate what FSGroup is used in the SecurityContext. type: string type: object @@ -230,7 +230,7 @@ spec: type: object priority: description: |- - Priority influences the sort order of SCCs when evaluating which SCCs to try first for + 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 @@ -241,7 +241,7 @@ spec: type: integer readOnlyRootFilesystem: description: |- - ReadOnlyRootFilesystem when set to true will force containers to run with a read only root file + 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 @@ -249,7 +249,7 @@ spec: type: boolean requiredDropCapabilities: description: |- - RequiredDropCapabilities are the capabilities that will be dropped from the container. These + requiredDropCapabilities are the capabilities that will be dropped from the container. These are required to be dropped and cannot be added. items: description: Capability represent POSIX capabilities type @@ -258,33 +258,33 @@ spec: type: array x-kubernetes-list-type: atomic runAsUser: - description: RunAsUser is the strategy that will dictate what RunAsUser + description: runAsUser is the strategy that will dictate what RunAsUser is used in the SecurityContext. nullable: true properties: type: - description: Type is the strategy that will dictate what RunAsUser + description: type is the strategy that will dictate what RunAsUser is used in the SecurityContext. type: string uid: description: |- - UID is the user id that containers must run as. Required for the MustRunAs strategy if not using + uid is the user id that containers must run as. Required for the MustRunAs strategy if not using namespace/service account allocated uids. format: int64 type: integer uidRangeMax: - description: UIDRangeMax defines the max value for a strategy that + description: uidRangeMax defines the max value for a strategy that allocates by range. format: int64 type: integer uidRangeMin: - description: UIDRangeMin defines the min value for a strategy that + description: uidRangeMin defines the min value for a strategy that allocates by range. format: int64 type: integer type: object seLinuxContext: - description: SELinuxContext is the strategy that will dictate what labels + description: seLinuxContext is the strategy that will dictate what labels will be set in the SecurityContext. nullable: true properties: @@ -309,12 +309,12 @@ spec: type: string type: object type: - description: Type is the strategy that will dictate what SELinux context + description: type is the strategy that will dictate what SELinux context is used in the SecurityContext. type: string type: object seccompProfiles: - description: "SeccompProfiles lists the allowed profiles that may be set + description: "seccompProfiles lists the allowed profiles that may be set for the pod or\ncontainer's seccomp annotations. An unset (nil) or empty value means that no profiles may\nbe specifid by the pod or container.\tThe wildcard '*' may be used to allow all profiles. When\nused to generate @@ -326,30 +326,30 @@ spec: type: array x-kubernetes-list-type: atomic supplementalGroups: - description: SupplementalGroups is the strategy that will dictate what + description: supplementalGroups is the strategy that will dictate what supplemental groups are used by the SecurityContext. nullable: true properties: ranges: description: |- - Ranges are the allowed ranges of supplemental groups. If you would like to force a single + 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. items: description: IDRange provides a min/max of an allowed range of IDs. properties: max: - description: Max is the end of the range, inclusive. + description: max is the end of the range, inclusive. format: int64 type: integer min: - description: Min is the start of the range, inclusive. + description: min is the start of the range, inclusive. format: int64 type: integer type: object type: array x-kubernetes-list-type: atomic type: - description: Type is the strategy that will dictate what supplemental + description: type is the strategy that will dictate what supplemental groups is used in the SecurityContext. type: string type: object @@ -363,7 +363,7 @@ spec: x-kubernetes-list-type: atomic volumes: description: |- - Volumes is a white list of allowed volume plugins. FSType corresponds directly with the field names + 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"]. items: diff --git a/payload-manifests/crds/0000_03_config-operator_01_securitycontextconstraints-DevPreviewNoUpgrade.crd.yaml b/payload-manifests/crds/0000_03_config-operator_01_securitycontextconstraints-DevPreviewNoUpgrade.crd.yaml index b008141865d..301329c8dd0 100644 --- a/payload-manifests/crds/0000_03_config-operator_01_securitycontextconstraints-DevPreviewNoUpgrade.crd.yaml +++ b/payload-manifests/crds/0000_03_config-operator_01_securitycontextconstraints-DevPreviewNoUpgrade.crd.yaml @@ -70,38 +70,38 @@ spec: Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). properties: allowHostDirVolumePlugin: - description: AllowHostDirVolumePlugin determines if the policy allow containers + description: allowHostDirVolumePlugin determines if the policy allow containers to use the HostDir volume plugin type: boolean allowHostIPC: - description: AllowHostIPC determines if the policy allows host ipc in + description: allowHostIPC determines if the policy allows host ipc in the containers. type: boolean allowHostNetwork: - description: AllowHostNetwork determines if the policy allows the use + description: allowHostNetwork determines if the policy allows the use of HostNetwork in the pod spec. type: boolean allowHostPID: - description: AllowHostPID determines if the policy allows host pid in + description: allowHostPID determines if the policy allows host pid in the containers. type: boolean allowHostPorts: - description: AllowHostPorts determines if the policy allows host ports + description: allowHostPorts determines if the policy allows host ports in the containers. type: boolean allowPrivilegeEscalation: description: |- - AllowPrivilegeEscalation determines if a pod can request to allow + allowPrivilegeEscalation determines if a pod can request to allow privilege escalation. If unspecified, defaults to true. nullable: true type: boolean allowPrivilegedContainer: - description: AllowPrivilegedContainer determines if a container can request + description: allowPrivilegedContainer determines if a container can request to be run as privileged. type: boolean allowedCapabilities: description: |- - AllowedCapabilities is a list of capabilities that can be requested to add to the container. + 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 '*'. @@ -113,7 +113,7 @@ spec: x-kubernetes-list-type: atomic allowedFlexVolumes: description: |- - AllowedFlexVolumes is a whitelist of allowed Flexvolumes. Empty or nil indicates that all + 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. items: @@ -121,7 +121,7 @@ spec: allowed to be used. properties: driver: - description: Driver is the name of the Flexvolume driver. + description: driver is the name of the Flexvolume driver. type: string required: - driver @@ -131,7 +131,7 @@ spec: x-kubernetes-list-type: atomic allowedUnsafeSysctls: description: |- - AllowedUnsafeSysctls is a list of explicitly allowed unsafe sysctls, defaults to none. + 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. @@ -153,7 +153,7 @@ spec: type: string defaultAddCapabilities: description: |- - DefaultAddCapabilities is the default set of capabilities that will be added to the container + 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. items: @@ -164,13 +164,13 @@ spec: x-kubernetes-list-type: atomic defaultAllowPrivilegeEscalation: description: |- - DefaultAllowPrivilegeEscalation controls the default setting for whether a + defaultAllowPrivilegeEscalation controls the default setting for whether a process can gain more privileges than its parent process. nullable: true type: boolean forbiddenSysctls: description: |- - ForbiddenSysctls is a list of explicitly forbidden sysctls, defaults to none. + 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. @@ -183,30 +183,30 @@ spec: type: array x-kubernetes-list-type: atomic fsGroup: - description: FSGroup is the strategy that will dictate what fs group is + description: fsGroup is the strategy that will dictate what fs group is used by the SecurityContext. nullable: true properties: ranges: description: |- - Ranges are the allowed ranges of fs groups. If you would like to force a single + 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. items: description: IDRange provides a min/max of an allowed range of IDs. properties: max: - description: Max is the end of the range, inclusive. + description: max is the end of the range, inclusive. format: int64 type: integer min: - description: Min is the start of the range, inclusive. + description: min is the start of the range, inclusive. format: int64 type: integer type: object type: array x-kubernetes-list-type: atomic type: - description: Type is the strategy that will dictate what FSGroup is + description: type is the strategy that will dictate what FSGroup is used in the SecurityContext. type: string type: object @@ -230,7 +230,7 @@ spec: type: object priority: description: |- - Priority influences the sort order of SCCs when evaluating which SCCs to try first for + 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 @@ -241,7 +241,7 @@ spec: type: integer readOnlyRootFilesystem: description: |- - ReadOnlyRootFilesystem when set to true will force containers to run with a read only root file + 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 @@ -249,7 +249,7 @@ spec: type: boolean requiredDropCapabilities: description: |- - RequiredDropCapabilities are the capabilities that will be dropped from the container. These + requiredDropCapabilities are the capabilities that will be dropped from the container. These are required to be dropped and cannot be added. items: description: Capability represent POSIX capabilities type @@ -258,33 +258,33 @@ spec: type: array x-kubernetes-list-type: atomic runAsUser: - description: RunAsUser is the strategy that will dictate what RunAsUser + description: runAsUser is the strategy that will dictate what RunAsUser is used in the SecurityContext. nullable: true properties: type: - description: Type is the strategy that will dictate what RunAsUser + description: type is the strategy that will dictate what RunAsUser is used in the SecurityContext. type: string uid: description: |- - UID is the user id that containers must run as. Required for the MustRunAs strategy if not using + uid is the user id that containers must run as. Required for the MustRunAs strategy if not using namespace/service account allocated uids. format: int64 type: integer uidRangeMax: - description: UIDRangeMax defines the max value for a strategy that + description: uidRangeMax defines the max value for a strategy that allocates by range. format: int64 type: integer uidRangeMin: - description: UIDRangeMin defines the min value for a strategy that + description: uidRangeMin defines the min value for a strategy that allocates by range. format: int64 type: integer type: object seLinuxContext: - description: SELinuxContext is the strategy that will dictate what labels + description: seLinuxContext is the strategy that will dictate what labels will be set in the SecurityContext. nullable: true properties: @@ -309,12 +309,12 @@ spec: type: string type: object type: - description: Type is the strategy that will dictate what SELinux context + description: type is the strategy that will dictate what SELinux context is used in the SecurityContext. type: string type: object seccompProfiles: - description: "SeccompProfiles lists the allowed profiles that may be set + description: "seccompProfiles lists the allowed profiles that may be set for the pod or\ncontainer's seccomp annotations. An unset (nil) or empty value means that no profiles may\nbe specifid by the pod or container.\tThe wildcard '*' may be used to allow all profiles. When\nused to generate @@ -326,30 +326,30 @@ spec: type: array x-kubernetes-list-type: atomic supplementalGroups: - description: SupplementalGroups is the strategy that will dictate what + description: supplementalGroups is the strategy that will dictate what supplemental groups are used by the SecurityContext. nullable: true properties: ranges: description: |- - Ranges are the allowed ranges of supplemental groups. If you would like to force a single + 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. items: description: IDRange provides a min/max of an allowed range of IDs. properties: max: - description: Max is the end of the range, inclusive. + description: max is the end of the range, inclusive. format: int64 type: integer min: - description: Min is the start of the range, inclusive. + description: min is the start of the range, inclusive. format: int64 type: integer type: object type: array x-kubernetes-list-type: atomic type: - description: Type is the strategy that will dictate what supplemental + description: type is the strategy that will dictate what supplemental groups is used in the SecurityContext. type: string type: object @@ -375,7 +375,7 @@ spec: x-kubernetes-list-type: atomic volumes: description: |- - Volumes is a white list of allowed volume plugins. FSType corresponds directly with the field names + 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"]. items: diff --git a/payload-manifests/crds/0000_03_config-operator_01_securitycontextconstraints-TechPreviewNoUpgrade.crd.yaml b/payload-manifests/crds/0000_03_config-operator_01_securitycontextconstraints-TechPreviewNoUpgrade.crd.yaml index ab99396f3ac..a10601e8844 100644 --- a/payload-manifests/crds/0000_03_config-operator_01_securitycontextconstraints-TechPreviewNoUpgrade.crd.yaml +++ b/payload-manifests/crds/0000_03_config-operator_01_securitycontextconstraints-TechPreviewNoUpgrade.crd.yaml @@ -70,38 +70,38 @@ spec: Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). properties: allowHostDirVolumePlugin: - description: AllowHostDirVolumePlugin determines if the policy allow containers + description: allowHostDirVolumePlugin determines if the policy allow containers to use the HostDir volume plugin type: boolean allowHostIPC: - description: AllowHostIPC determines if the policy allows host ipc in + description: allowHostIPC determines if the policy allows host ipc in the containers. type: boolean allowHostNetwork: - description: AllowHostNetwork determines if the policy allows the use + description: allowHostNetwork determines if the policy allows the use of HostNetwork in the pod spec. type: boolean allowHostPID: - description: AllowHostPID determines if the policy allows host pid in + description: allowHostPID determines if the policy allows host pid in the containers. type: boolean allowHostPorts: - description: AllowHostPorts determines if the policy allows host ports + description: allowHostPorts determines if the policy allows host ports in the containers. type: boolean allowPrivilegeEscalation: description: |- - AllowPrivilegeEscalation determines if a pod can request to allow + allowPrivilegeEscalation determines if a pod can request to allow privilege escalation. If unspecified, defaults to true. nullable: true type: boolean allowPrivilegedContainer: - description: AllowPrivilegedContainer determines if a container can request + description: allowPrivilegedContainer determines if a container can request to be run as privileged. type: boolean allowedCapabilities: description: |- - AllowedCapabilities is a list of capabilities that can be requested to add to the container. + 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 '*'. @@ -113,7 +113,7 @@ spec: x-kubernetes-list-type: atomic allowedFlexVolumes: description: |- - AllowedFlexVolumes is a whitelist of allowed Flexvolumes. Empty or nil indicates that all + 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. items: @@ -121,7 +121,7 @@ spec: allowed to be used. properties: driver: - description: Driver is the name of the Flexvolume driver. + description: driver is the name of the Flexvolume driver. type: string required: - driver @@ -131,7 +131,7 @@ spec: x-kubernetes-list-type: atomic allowedUnsafeSysctls: description: |- - AllowedUnsafeSysctls is a list of explicitly allowed unsafe sysctls, defaults to none. + 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. @@ -153,7 +153,7 @@ spec: type: string defaultAddCapabilities: description: |- - DefaultAddCapabilities is the default set of capabilities that will be added to the container + 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. items: @@ -164,13 +164,13 @@ spec: x-kubernetes-list-type: atomic defaultAllowPrivilegeEscalation: description: |- - DefaultAllowPrivilegeEscalation controls the default setting for whether a + defaultAllowPrivilegeEscalation controls the default setting for whether a process can gain more privileges than its parent process. nullable: true type: boolean forbiddenSysctls: description: |- - ForbiddenSysctls is a list of explicitly forbidden sysctls, defaults to none. + 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. @@ -183,30 +183,30 @@ spec: type: array x-kubernetes-list-type: atomic fsGroup: - description: FSGroup is the strategy that will dictate what fs group is + description: fsGroup is the strategy that will dictate what fs group is used by the SecurityContext. nullable: true properties: ranges: description: |- - Ranges are the allowed ranges of fs groups. If you would like to force a single + 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. items: description: IDRange provides a min/max of an allowed range of IDs. properties: max: - description: Max is the end of the range, inclusive. + description: max is the end of the range, inclusive. format: int64 type: integer min: - description: Min is the start of the range, inclusive. + description: min is the start of the range, inclusive. format: int64 type: integer type: object type: array x-kubernetes-list-type: atomic type: - description: Type is the strategy that will dictate what FSGroup is + description: type is the strategy that will dictate what FSGroup is used in the SecurityContext. type: string type: object @@ -230,7 +230,7 @@ spec: type: object priority: description: |- - Priority influences the sort order of SCCs when evaluating which SCCs to try first for + 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 @@ -241,7 +241,7 @@ spec: type: integer readOnlyRootFilesystem: description: |- - ReadOnlyRootFilesystem when set to true will force containers to run with a read only root file + 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 @@ -249,7 +249,7 @@ spec: type: boolean requiredDropCapabilities: description: |- - RequiredDropCapabilities are the capabilities that will be dropped from the container. These + requiredDropCapabilities are the capabilities that will be dropped from the container. These are required to be dropped and cannot be added. items: description: Capability represent POSIX capabilities type @@ -258,33 +258,33 @@ spec: type: array x-kubernetes-list-type: atomic runAsUser: - description: RunAsUser is the strategy that will dictate what RunAsUser + description: runAsUser is the strategy that will dictate what RunAsUser is used in the SecurityContext. nullable: true properties: type: - description: Type is the strategy that will dictate what RunAsUser + description: type is the strategy that will dictate what RunAsUser is used in the SecurityContext. type: string uid: description: |- - UID is the user id that containers must run as. Required for the MustRunAs strategy if not using + uid is the user id that containers must run as. Required for the MustRunAs strategy if not using namespace/service account allocated uids. format: int64 type: integer uidRangeMax: - description: UIDRangeMax defines the max value for a strategy that + description: uidRangeMax defines the max value for a strategy that allocates by range. format: int64 type: integer uidRangeMin: - description: UIDRangeMin defines the min value for a strategy that + description: uidRangeMin defines the min value for a strategy that allocates by range. format: int64 type: integer type: object seLinuxContext: - description: SELinuxContext is the strategy that will dictate what labels + description: seLinuxContext is the strategy that will dictate what labels will be set in the SecurityContext. nullable: true properties: @@ -309,12 +309,12 @@ spec: type: string type: object type: - description: Type is the strategy that will dictate what SELinux context + description: type is the strategy that will dictate what SELinux context is used in the SecurityContext. type: string type: object seccompProfiles: - description: "SeccompProfiles lists the allowed profiles that may be set + description: "seccompProfiles lists the allowed profiles that may be set for the pod or\ncontainer's seccomp annotations. An unset (nil) or empty value means that no profiles may\nbe specifid by the pod or container.\tThe wildcard '*' may be used to allow all profiles. When\nused to generate @@ -326,30 +326,30 @@ spec: type: array x-kubernetes-list-type: atomic supplementalGroups: - description: SupplementalGroups is the strategy that will dictate what + description: supplementalGroups is the strategy that will dictate what supplemental groups are used by the SecurityContext. nullable: true properties: ranges: description: |- - Ranges are the allowed ranges of supplemental groups. If you would like to force a single + 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. items: description: IDRange provides a min/max of an allowed range of IDs. properties: max: - description: Max is the end of the range, inclusive. + description: max is the end of the range, inclusive. format: int64 type: integer min: - description: Min is the start of the range, inclusive. + description: min is the start of the range, inclusive. format: int64 type: integer type: object type: array x-kubernetes-list-type: atomic type: - description: Type is the strategy that will dictate what supplemental + description: type is the strategy that will dictate what supplemental groups is used in the SecurityContext. type: string type: object @@ -375,7 +375,7 @@ spec: x-kubernetes-list-type: atomic volumes: description: |- - Volumes is a white list of allowed volume plugins. FSType corresponds directly with the field names + 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"]. items: diff --git a/payload-manifests/crds/0000_10_config-operator_01_authentications-Hypershift.crd.yaml b/payload-manifests/crds/0000_10_config-operator_01_authentications-Hypershift.crd.yaml index 8f7dc33442c..93b2b00626a 100644 --- a/payload-manifests/crds/0000_10_config-operator_01_authentications-Hypershift.crd.yaml +++ b/payload-manifests/crds/0000_10_config-operator_01_authentications-Hypershift.crd.yaml @@ -69,7 +69,7 @@ spec: type: object oidcProviders: description: |- - OIDCProviders are OIDC identity providers that can issue tokens + oidcProviders are OIDC identity providers that can issue tokens for this cluster Can only be set if "Type" is set to "OIDC". @@ -78,22 +78,22 @@ spec: properties: claimMappings: description: |- - ClaimMappings describes rules on how to transform information from an + claimMappings describes rules on how to transform information from an ID token into a cluster identity properties: groups: description: |- - Groups is a name of the claim that should be used to construct + groups is a name of the claim that should be used to construct groups for the cluster identity. The referenced claim must use array of strings values. properties: claim: - description: Claim is a JWT token claim to be used in + description: claim is a JWT token claim to be used in the mapping type: string prefix: description: |- - Prefix is a string to prefix the value from the token in the result of the + prefix is a string to prefix the value from the token in the result of the claim mapping. By default, no prefixing occurs. @@ -107,13 +107,13 @@ spec: type: object username: description: |- - Username is a name of the claim that should be used to construct + username is a name of the claim that should be used to construct usernames for the cluster identity. Default value: "sub" properties: claim: - description: Claim is a JWT token claim to be used in + description: claim is a JWT token claim to be used in the mapping type: string prefix: @@ -126,7 +126,7 @@ spec: type: object prefixPolicy: description: |- - PrefixPolicy specifies how a prefix should apply. + prefixPolicy specifies how a prefix should apply. By default, claims other than `email` will be prefixed with the issuer URL to prevent naming clashes with other plugins. @@ -161,23 +161,23 @@ spec: > 0) : !has(self.prefix)' type: object claimValidationRules: - description: ClaimValidationRules are rules that are applied + description: claimValidationRules are rules that are applied to validate token claims to authenticate users. items: properties: requiredClaim: description: |- - RequiredClaim allows configuring a required claim name and its expected + requiredClaim allows configuring a required claim name and its expected value properties: claim: description: |- - Claim is a name of a required claim. Only claims with string values are + claim is a name of a required claim. Only claims with string values are supported. minLength: 1 type: string requiredValue: - description: RequiredValue is the required value for + description: requiredValue is the required value for the claim. minLength: 1 type: string @@ -187,7 +187,7 @@ spec: type: object type: default: RequiredClaim - description: Type sets the type of the validation rule + description: type sets the type of the validation rule enum: - RequiredClaim type: string @@ -195,11 +195,11 @@ spec: type: array x-kubernetes-list-type: atomic issuer: - description: Issuer describes atributes of the OIDC token issuer + description: issuer describes atributes of the OIDC token issuer properties: audiences: description: |- - Audiences is an array of audiences that the token was issued for. + audiences is an array of audiences that the token was issued for. Valid tokens must include at least one of these values in their "aud" claim. Must be set to exactly one value. @@ -235,23 +235,23 @@ spec: - issuerURL type: object name: - description: Name of the OIDC provider + description: name of the OIDC provider minLength: 1 type: string oidcClients: description: |- - OIDCClients contains configuration for the platform's clients that + oidcClients contains configuration for the platform's clients that need to request tokens from the issuer items: properties: clientID: - description: ClientID is the identifier of the OIDC client + description: clientID is the identifier of the OIDC client from the OIDC provider minLength: 1 type: string clientSecret: description: |- - ClientSecret refers to a secret in the `openshift-config` namespace that + clientSecret refers to a secret in the `openshift-config` namespace that contains the client secret in the `clientSecret` key of the `.data` field properties: name: @@ -263,20 +263,20 @@ spec: type: object componentName: description: |- - ComponentName is the name of the component that is supposed to consume this + componentName is the name of the component that is supposed to consume this client configuration maxLength: 256 minLength: 1 type: string componentNamespace: description: |- - ComponentNamespace is the namespace of the component that is supposed to consume this + componentNamespace is the namespace of the component that is supposed to consume this client configuration maxLength: 63 minLength: 1 type: string extraScopes: - description: ExtraScopes is an optional set of scopes + description: extraScopes is an optional set of scopes to request tokens with. items: type: string @@ -414,25 +414,25 @@ spec: type: object oidcClients: description: |- - OIDCClients is where participating operators place the current OIDC client status + oidcClients is where participating operators place the current OIDC client status for OIDC clients that can be customized by the cluster-admin. items: properties: componentName: - description: ComponentName is the name of the component that + description: componentName is the name of the component that will consume a client configuration. maxLength: 256 minLength: 1 type: string componentNamespace: - description: ComponentNamespace is the namespace of the component + description: componentNamespace is the namespace of the component that will consume a client configuration. maxLength: 63 minLength: 1 type: string conditions: description: |- - Conditions are used to communicate the state of the `oidcClients` entry. + conditions are used to communicate the state of the `oidcClients` entry. Supported conditions include Available, Degraded and Progressing. @@ -500,7 +500,7 @@ spec: x-kubernetes-list-type: map consumingUsers: description: |- - ConsumingUsers is a slice of ServiceAccounts that need to have read + consumingUsers is a slice of ServiceAccounts that need to have read permission on the `clientSecret` secret. items: description: ConsumingUser is an alias for string which we @@ -513,12 +513,12 @@ spec: type: array x-kubernetes-list-type: set currentOIDCClients: - description: CurrentOIDCClients is a list of clients that the + description: currentOIDCClients is a list of clients that the component is currently using. items: properties: clientID: - description: ClientID is the identifier of the OIDC client + description: clientID is the identifier of the OIDC client from the OIDC provider minLength: 1 type: string diff --git a/payload-manifests/crds/0000_10_config-operator_01_authentications-SelfManagedHA-CustomNoUpgrade.crd.yaml b/payload-manifests/crds/0000_10_config-operator_01_authentications-SelfManagedHA-CustomNoUpgrade.crd.yaml index 9d7058b463a..07c2f49d234 100644 --- a/payload-manifests/crds/0000_10_config-operator_01_authentications-SelfManagedHA-CustomNoUpgrade.crd.yaml +++ b/payload-manifests/crds/0000_10_config-operator_01_authentications-SelfManagedHA-CustomNoUpgrade.crd.yaml @@ -70,7 +70,7 @@ spec: type: object oidcProviders: description: |- - OIDCProviders are OIDC identity providers that can issue tokens + oidcProviders are OIDC identity providers that can issue tokens for this cluster Can only be set if "Type" is set to "OIDC". @@ -79,22 +79,22 @@ spec: properties: claimMappings: description: |- - ClaimMappings describes rules on how to transform information from an + claimMappings describes rules on how to transform information from an ID token into a cluster identity properties: groups: description: |- - Groups is a name of the claim that should be used to construct + groups is a name of the claim that should be used to construct groups for the cluster identity. The referenced claim must use array of strings values. properties: claim: - description: Claim is a JWT token claim to be used in + description: claim is a JWT token claim to be used in the mapping type: string prefix: description: |- - Prefix is a string to prefix the value from the token in the result of the + prefix is a string to prefix the value from the token in the result of the claim mapping. By default, no prefixing occurs. @@ -108,13 +108,13 @@ spec: type: object username: description: |- - Username is a name of the claim that should be used to construct + username is a name of the claim that should be used to construct usernames for the cluster identity. Default value: "sub" properties: claim: - description: Claim is a JWT token claim to be used in + description: claim is a JWT token claim to be used in the mapping type: string prefix: @@ -127,7 +127,7 @@ spec: type: object prefixPolicy: description: |- - PrefixPolicy specifies how a prefix should apply. + prefixPolicy specifies how a prefix should apply. By default, claims other than `email` will be prefixed with the issuer URL to prevent naming clashes with other plugins. @@ -162,23 +162,23 @@ spec: > 0) : !has(self.prefix)' type: object claimValidationRules: - description: ClaimValidationRules are rules that are applied + description: claimValidationRules are rules that are applied to validate token claims to authenticate users. items: properties: requiredClaim: description: |- - RequiredClaim allows configuring a required claim name and its expected + requiredClaim allows configuring a required claim name and its expected value properties: claim: description: |- - Claim is a name of a required claim. Only claims with string values are + claim is a name of a required claim. Only claims with string values are supported. minLength: 1 type: string requiredValue: - description: RequiredValue is the required value for + description: requiredValue is the required value for the claim. minLength: 1 type: string @@ -188,7 +188,7 @@ spec: type: object type: default: RequiredClaim - description: Type sets the type of the validation rule + description: type sets the type of the validation rule enum: - RequiredClaim type: string @@ -196,11 +196,11 @@ spec: type: array x-kubernetes-list-type: atomic issuer: - description: Issuer describes atributes of the OIDC token issuer + description: issuer describes atributes of the OIDC token issuer properties: audiences: description: |- - Audiences is an array of audiences that the token was issued for. + audiences is an array of audiences that the token was issued for. Valid tokens must include at least one of these values in their "aud" claim. Must be set to exactly one value. @@ -236,23 +236,23 @@ spec: - issuerURL type: object name: - description: Name of the OIDC provider + description: name of the OIDC provider minLength: 1 type: string oidcClients: description: |- - OIDCClients contains configuration for the platform's clients that + oidcClients contains configuration for the platform's clients that need to request tokens from the issuer items: properties: clientID: - description: ClientID is the identifier of the OIDC client + description: clientID is the identifier of the OIDC client from the OIDC provider minLength: 1 type: string clientSecret: description: |- - ClientSecret refers to a secret in the `openshift-config` namespace that + clientSecret refers to a secret in the `openshift-config` namespace that contains the client secret in the `clientSecret` key of the `.data` field properties: name: @@ -264,20 +264,20 @@ spec: type: object componentName: description: |- - ComponentName is the name of the component that is supposed to consume this + componentName is the name of the component that is supposed to consume this client configuration maxLength: 256 minLength: 1 type: string componentNamespace: description: |- - ComponentNamespace is the namespace of the component that is supposed to consume this + componentNamespace is the namespace of the component that is supposed to consume this client configuration maxLength: 63 minLength: 1 type: string extraScopes: - description: ExtraScopes is an optional set of scopes + description: extraScopes is an optional set of scopes to request tokens with. items: type: string @@ -415,25 +415,25 @@ spec: type: object oidcClients: description: |- - OIDCClients is where participating operators place the current OIDC client status + oidcClients is where participating operators place the current OIDC client status for OIDC clients that can be customized by the cluster-admin. items: properties: componentName: - description: ComponentName is the name of the component that + description: componentName is the name of the component that will consume a client configuration. maxLength: 256 minLength: 1 type: string componentNamespace: - description: ComponentNamespace is the namespace of the component + description: componentNamespace is the namespace of the component that will consume a client configuration. maxLength: 63 minLength: 1 type: string conditions: description: |- - Conditions are used to communicate the state of the `oidcClients` entry. + conditions are used to communicate the state of the `oidcClients` entry. Supported conditions include Available, Degraded and Progressing. @@ -501,7 +501,7 @@ spec: x-kubernetes-list-type: map consumingUsers: description: |- - ConsumingUsers is a slice of ServiceAccounts that need to have read + consumingUsers is a slice of ServiceAccounts that need to have read permission on the `clientSecret` secret. items: description: ConsumingUser is an alias for string which we @@ -514,12 +514,12 @@ spec: type: array x-kubernetes-list-type: set currentOIDCClients: - description: CurrentOIDCClients is a list of clients that the + description: currentOIDCClients is a list of clients that the component is currently using. items: properties: clientID: - description: ClientID is the identifier of the OIDC client + description: clientID is the identifier of the OIDC client from the OIDC provider minLength: 1 type: string diff --git a/payload-manifests/crds/0000_10_config-operator_01_authentications-SelfManagedHA-DevPreviewNoUpgrade.crd.yaml b/payload-manifests/crds/0000_10_config-operator_01_authentications-SelfManagedHA-DevPreviewNoUpgrade.crd.yaml index b2968832e3c..718aeff5d10 100644 --- a/payload-manifests/crds/0000_10_config-operator_01_authentications-SelfManagedHA-DevPreviewNoUpgrade.crd.yaml +++ b/payload-manifests/crds/0000_10_config-operator_01_authentications-SelfManagedHA-DevPreviewNoUpgrade.crd.yaml @@ -70,7 +70,7 @@ spec: type: object oidcProviders: description: |- - OIDCProviders are OIDC identity providers that can issue tokens + oidcProviders are OIDC identity providers that can issue tokens for this cluster Can only be set if "Type" is set to "OIDC". @@ -79,22 +79,22 @@ spec: properties: claimMappings: description: |- - ClaimMappings describes rules on how to transform information from an + claimMappings describes rules on how to transform information from an ID token into a cluster identity properties: groups: description: |- - Groups is a name of the claim that should be used to construct + groups is a name of the claim that should be used to construct groups for the cluster identity. The referenced claim must use array of strings values. properties: claim: - description: Claim is a JWT token claim to be used in + description: claim is a JWT token claim to be used in the mapping type: string prefix: description: |- - Prefix is a string to prefix the value from the token in the result of the + prefix is a string to prefix the value from the token in the result of the claim mapping. By default, no prefixing occurs. @@ -108,13 +108,13 @@ spec: type: object username: description: |- - Username is a name of the claim that should be used to construct + username is a name of the claim that should be used to construct usernames for the cluster identity. Default value: "sub" properties: claim: - description: Claim is a JWT token claim to be used in + description: claim is a JWT token claim to be used in the mapping type: string prefix: @@ -127,7 +127,7 @@ spec: type: object prefixPolicy: description: |- - PrefixPolicy specifies how a prefix should apply. + prefixPolicy specifies how a prefix should apply. By default, claims other than `email` will be prefixed with the issuer URL to prevent naming clashes with other plugins. @@ -162,23 +162,23 @@ spec: > 0) : !has(self.prefix)' type: object claimValidationRules: - description: ClaimValidationRules are rules that are applied + description: claimValidationRules are rules that are applied to validate token claims to authenticate users. items: properties: requiredClaim: description: |- - RequiredClaim allows configuring a required claim name and its expected + requiredClaim allows configuring a required claim name and its expected value properties: claim: description: |- - Claim is a name of a required claim. Only claims with string values are + claim is a name of a required claim. Only claims with string values are supported. minLength: 1 type: string requiredValue: - description: RequiredValue is the required value for + description: requiredValue is the required value for the claim. minLength: 1 type: string @@ -188,7 +188,7 @@ spec: type: object type: default: RequiredClaim - description: Type sets the type of the validation rule + description: type sets the type of the validation rule enum: - RequiredClaim type: string @@ -196,11 +196,11 @@ spec: type: array x-kubernetes-list-type: atomic issuer: - description: Issuer describes atributes of the OIDC token issuer + description: issuer describes atributes of the OIDC token issuer properties: audiences: description: |- - Audiences is an array of audiences that the token was issued for. + audiences is an array of audiences that the token was issued for. Valid tokens must include at least one of these values in their "aud" claim. Must be set to exactly one value. @@ -236,23 +236,23 @@ spec: - issuerURL type: object name: - description: Name of the OIDC provider + description: name of the OIDC provider minLength: 1 type: string oidcClients: description: |- - OIDCClients contains configuration for the platform's clients that + oidcClients contains configuration for the platform's clients that need to request tokens from the issuer items: properties: clientID: - description: ClientID is the identifier of the OIDC client + description: clientID is the identifier of the OIDC client from the OIDC provider minLength: 1 type: string clientSecret: description: |- - ClientSecret refers to a secret in the `openshift-config` namespace that + clientSecret refers to a secret in the `openshift-config` namespace that contains the client secret in the `clientSecret` key of the `.data` field properties: name: @@ -264,20 +264,20 @@ spec: type: object componentName: description: |- - ComponentName is the name of the component that is supposed to consume this + componentName is the name of the component that is supposed to consume this client configuration maxLength: 256 minLength: 1 type: string componentNamespace: description: |- - ComponentNamespace is the namespace of the component that is supposed to consume this + componentNamespace is the namespace of the component that is supposed to consume this client configuration maxLength: 63 minLength: 1 type: string extraScopes: - description: ExtraScopes is an optional set of scopes + description: extraScopes is an optional set of scopes to request tokens with. items: type: string @@ -415,25 +415,25 @@ spec: type: object oidcClients: description: |- - OIDCClients is where participating operators place the current OIDC client status + oidcClients is where participating operators place the current OIDC client status for OIDC clients that can be customized by the cluster-admin. items: properties: componentName: - description: ComponentName is the name of the component that + description: componentName is the name of the component that will consume a client configuration. maxLength: 256 minLength: 1 type: string componentNamespace: - description: ComponentNamespace is the namespace of the component + description: componentNamespace is the namespace of the component that will consume a client configuration. maxLength: 63 minLength: 1 type: string conditions: description: |- - Conditions are used to communicate the state of the `oidcClients` entry. + conditions are used to communicate the state of the `oidcClients` entry. Supported conditions include Available, Degraded and Progressing. @@ -501,7 +501,7 @@ spec: x-kubernetes-list-type: map consumingUsers: description: |- - ConsumingUsers is a slice of ServiceAccounts that need to have read + consumingUsers is a slice of ServiceAccounts that need to have read permission on the `clientSecret` secret. items: description: ConsumingUser is an alias for string which we @@ -514,12 +514,12 @@ spec: type: array x-kubernetes-list-type: set currentOIDCClients: - description: CurrentOIDCClients is a list of clients that the + description: currentOIDCClients is a list of clients that the component is currently using. items: properties: clientID: - description: ClientID is the identifier of the OIDC client + description: clientID is the identifier of the OIDC client from the OIDC provider minLength: 1 type: string diff --git a/payload-manifests/crds/0000_10_config-operator_01_authentications-SelfManagedHA-TechPreviewNoUpgrade.crd.yaml b/payload-manifests/crds/0000_10_config-operator_01_authentications-SelfManagedHA-TechPreviewNoUpgrade.crd.yaml index bd450f3a7dd..875290968b7 100644 --- a/payload-manifests/crds/0000_10_config-operator_01_authentications-SelfManagedHA-TechPreviewNoUpgrade.crd.yaml +++ b/payload-manifests/crds/0000_10_config-operator_01_authentications-SelfManagedHA-TechPreviewNoUpgrade.crd.yaml @@ -70,7 +70,7 @@ spec: type: object oidcProviders: description: |- - OIDCProviders are OIDC identity providers that can issue tokens + oidcProviders are OIDC identity providers that can issue tokens for this cluster Can only be set if "Type" is set to "OIDC". @@ -79,22 +79,22 @@ spec: properties: claimMappings: description: |- - ClaimMappings describes rules on how to transform information from an + claimMappings describes rules on how to transform information from an ID token into a cluster identity properties: groups: description: |- - Groups is a name of the claim that should be used to construct + groups is a name of the claim that should be used to construct groups for the cluster identity. The referenced claim must use array of strings values. properties: claim: - description: Claim is a JWT token claim to be used in + description: claim is a JWT token claim to be used in the mapping type: string prefix: description: |- - Prefix is a string to prefix the value from the token in the result of the + prefix is a string to prefix the value from the token in the result of the claim mapping. By default, no prefixing occurs. @@ -108,13 +108,13 @@ spec: type: object username: description: |- - Username is a name of the claim that should be used to construct + username is a name of the claim that should be used to construct usernames for the cluster identity. Default value: "sub" properties: claim: - description: Claim is a JWT token claim to be used in + description: claim is a JWT token claim to be used in the mapping type: string prefix: @@ -127,7 +127,7 @@ spec: type: object prefixPolicy: description: |- - PrefixPolicy specifies how a prefix should apply. + prefixPolicy specifies how a prefix should apply. By default, claims other than `email` will be prefixed with the issuer URL to prevent naming clashes with other plugins. @@ -162,23 +162,23 @@ spec: > 0) : !has(self.prefix)' type: object claimValidationRules: - description: ClaimValidationRules are rules that are applied + description: claimValidationRules are rules that are applied to validate token claims to authenticate users. items: properties: requiredClaim: description: |- - RequiredClaim allows configuring a required claim name and its expected + requiredClaim allows configuring a required claim name and its expected value properties: claim: description: |- - Claim is a name of a required claim. Only claims with string values are + claim is a name of a required claim. Only claims with string values are supported. minLength: 1 type: string requiredValue: - description: RequiredValue is the required value for + description: requiredValue is the required value for the claim. minLength: 1 type: string @@ -188,7 +188,7 @@ spec: type: object type: default: RequiredClaim - description: Type sets the type of the validation rule + description: type sets the type of the validation rule enum: - RequiredClaim type: string @@ -196,11 +196,11 @@ spec: type: array x-kubernetes-list-type: atomic issuer: - description: Issuer describes atributes of the OIDC token issuer + description: issuer describes atributes of the OIDC token issuer properties: audiences: description: |- - Audiences is an array of audiences that the token was issued for. + audiences is an array of audiences that the token was issued for. Valid tokens must include at least one of these values in their "aud" claim. Must be set to exactly one value. @@ -236,23 +236,23 @@ spec: - issuerURL type: object name: - description: Name of the OIDC provider + description: name of the OIDC provider minLength: 1 type: string oidcClients: description: |- - OIDCClients contains configuration for the platform's clients that + oidcClients contains configuration for the platform's clients that need to request tokens from the issuer items: properties: clientID: - description: ClientID is the identifier of the OIDC client + description: clientID is the identifier of the OIDC client from the OIDC provider minLength: 1 type: string clientSecret: description: |- - ClientSecret refers to a secret in the `openshift-config` namespace that + clientSecret refers to a secret in the `openshift-config` namespace that contains the client secret in the `clientSecret` key of the `.data` field properties: name: @@ -264,20 +264,20 @@ spec: type: object componentName: description: |- - ComponentName is the name of the component that is supposed to consume this + componentName is the name of the component that is supposed to consume this client configuration maxLength: 256 minLength: 1 type: string componentNamespace: description: |- - ComponentNamespace is the namespace of the component that is supposed to consume this + componentNamespace is the namespace of the component that is supposed to consume this client configuration maxLength: 63 minLength: 1 type: string extraScopes: - description: ExtraScopes is an optional set of scopes + description: extraScopes is an optional set of scopes to request tokens with. items: type: string @@ -415,25 +415,25 @@ spec: type: object oidcClients: description: |- - OIDCClients is where participating operators place the current OIDC client status + oidcClients is where participating operators place the current OIDC client status for OIDC clients that can be customized by the cluster-admin. items: properties: componentName: - description: ComponentName is the name of the component that + description: componentName is the name of the component that will consume a client configuration. maxLength: 256 minLength: 1 type: string componentNamespace: - description: ComponentNamespace is the namespace of the component + description: componentNamespace is the namespace of the component that will consume a client configuration. maxLength: 63 minLength: 1 type: string conditions: description: |- - Conditions are used to communicate the state of the `oidcClients` entry. + conditions are used to communicate the state of the `oidcClients` entry. Supported conditions include Available, Degraded and Progressing. @@ -501,7 +501,7 @@ spec: x-kubernetes-list-type: map consumingUsers: description: |- - ConsumingUsers is a slice of ServiceAccounts that need to have read + consumingUsers is a slice of ServiceAccounts that need to have read permission on the `clientSecret` secret. items: description: ConsumingUser is an alias for string which we @@ -514,12 +514,12 @@ spec: type: array x-kubernetes-list-type: set currentOIDCClients: - description: CurrentOIDCClients is a list of clients that the + description: currentOIDCClients is a list of clients that the component is currently using. items: properties: clientID: - description: ClientID is the identifier of the OIDC client + description: clientID is the identifier of the OIDC client from the OIDC provider minLength: 1 type: string diff --git a/payload-manifests/crds/0000_10_config-operator_01_backups-CustomNoUpgrade.crd.yaml b/payload-manifests/crds/0000_10_config-operator_01_backups-CustomNoUpgrade.crd.yaml index 48a6aa7dcb2..aba325d8834 100644 --- a/payload-manifests/crds/0000_10_config-operator_01_backups-CustomNoUpgrade.crd.yaml +++ b/payload-manifests/crds/0000_10_config-operator_01_backups-CustomNoUpgrade.crd.yaml @@ -51,23 +51,23 @@ spec: properties: pvcName: description: |- - PVCName specifies the name of the PersistentVolumeClaim (PVC) which binds a PersistentVolume where the + 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 retentionPolicy: - description: RetentionPolicy defines the retention policy for + description: retentionPolicy defines the retention policy for retaining and deleting existing backups. properties: retentionNumber: - description: RetentionNumber configures the retention policy + description: retentionNumber configures the retention policy based on the number of backups properties: maxNumberOfBackups: description: |- - MaxNumberOfBackups defines the maximum number of backups to retain. + 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. minimum: 1 @@ -76,12 +76,12 @@ spec: - maxNumberOfBackups type: object retentionSize: - description: RetentionSize configures the retention policy + description: retentionSize configures the retention policy based on the size of backups properties: maxSizeOfBackupsGb: description: |- - MaxSizeOfBackupsGb defines the total size in GB of backups to retain. + 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. minimum: 1 @@ -99,7 +99,7 @@ spec: - RetentionNumber - RetentionSize description: |- - RetentionType sets the type of retention policy. + 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. @@ -109,7 +109,7 @@ spec: type: object schedule: description: |- - Schedule defines the recurring backup schedule in Cron format + 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. diff --git a/payload-manifests/crds/0000_10_config-operator_01_backups-DevPreviewNoUpgrade.crd.yaml b/payload-manifests/crds/0000_10_config-operator_01_backups-DevPreviewNoUpgrade.crd.yaml index 4fa66b80aae..62339318c47 100644 --- a/payload-manifests/crds/0000_10_config-operator_01_backups-DevPreviewNoUpgrade.crd.yaml +++ b/payload-manifests/crds/0000_10_config-operator_01_backups-DevPreviewNoUpgrade.crd.yaml @@ -51,23 +51,23 @@ spec: properties: pvcName: description: |- - PVCName specifies the name of the PersistentVolumeClaim (PVC) which binds a PersistentVolume where the + 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 retentionPolicy: - description: RetentionPolicy defines the retention policy for + description: retentionPolicy defines the retention policy for retaining and deleting existing backups. properties: retentionNumber: - description: RetentionNumber configures the retention policy + description: retentionNumber configures the retention policy based on the number of backups properties: maxNumberOfBackups: description: |- - MaxNumberOfBackups defines the maximum number of backups to retain. + 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. minimum: 1 @@ -76,12 +76,12 @@ spec: - maxNumberOfBackups type: object retentionSize: - description: RetentionSize configures the retention policy + description: retentionSize configures the retention policy based on the size of backups properties: maxSizeOfBackupsGb: description: |- - MaxSizeOfBackupsGb defines the total size in GB of backups to retain. + 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. minimum: 1 @@ -99,7 +99,7 @@ spec: - RetentionNumber - RetentionSize description: |- - RetentionType sets the type of retention policy. + 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. @@ -109,7 +109,7 @@ spec: type: object schedule: description: |- - Schedule defines the recurring backup schedule in Cron format + 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. diff --git a/payload-manifests/crds/0000_10_config-operator_01_backups-TechPreviewNoUpgrade.crd.yaml b/payload-manifests/crds/0000_10_config-operator_01_backups-TechPreviewNoUpgrade.crd.yaml index 41d03aa7b5e..7ce67bdaf35 100644 --- a/payload-manifests/crds/0000_10_config-operator_01_backups-TechPreviewNoUpgrade.crd.yaml +++ b/payload-manifests/crds/0000_10_config-operator_01_backups-TechPreviewNoUpgrade.crd.yaml @@ -51,23 +51,23 @@ spec: properties: pvcName: description: |- - PVCName specifies the name of the PersistentVolumeClaim (PVC) which binds a PersistentVolume where the + 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 retentionPolicy: - description: RetentionPolicy defines the retention policy for + description: retentionPolicy defines the retention policy for retaining and deleting existing backups. properties: retentionNumber: - description: RetentionNumber configures the retention policy + description: retentionNumber configures the retention policy based on the number of backups properties: maxNumberOfBackups: description: |- - MaxNumberOfBackups defines the maximum number of backups to retain. + 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. minimum: 1 @@ -76,12 +76,12 @@ spec: - maxNumberOfBackups type: object retentionSize: - description: RetentionSize configures the retention policy + description: retentionSize configures the retention policy based on the size of backups properties: maxSizeOfBackupsGb: description: |- - MaxSizeOfBackupsGb defines the total size in GB of backups to retain. + 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. minimum: 1 @@ -99,7 +99,7 @@ spec: - RetentionNumber - RetentionSize description: |- - RetentionType sets the type of retention policy. + 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. @@ -109,7 +109,7 @@ spec: type: object schedule: description: |- - Schedule defines the recurring backup schedule in Cron format + 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. diff --git a/payload-manifests/crds/0000_10_config-operator_01_infrastructures-CustomNoUpgrade.crd.yaml b/payload-manifests/crds/0000_10_config-operator_01_infrastructures-CustomNoUpgrade.crd.yaml index 1c97887ceca..72534aad462 100644 --- a/payload-manifests/crds/0000_10_config-operator_01_infrastructures-CustomNoUpgrade.crd.yaml +++ b/payload-manifests/crds/0000_10_config-operator_01_infrastructures-CustomNoUpgrade.crd.yaml @@ -62,7 +62,7 @@ spec: All the clients are expected to use the generated ConfigMap only. properties: key: - description: Key allows pointing to a specific key/value inside + description: key allows pointing to a specific key/value inside of the configmap. This is useful for logical file references. type: string name: @@ -74,11 +74,11 @@ spec: infrastructure provider. properties: alibabaCloud: - description: AlibabaCloud contains settings specific to the Alibaba + description: alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. type: object aws: - description: AWS contains settings specific to the Amazon Web + description: aws contains settings specific to the Amazon Web Services infrastructure provider. properties: serviceEndpoints: @@ -110,11 +110,11 @@ spec: x-kubernetes-list-type: atomic type: object azure: - description: Azure contains settings specific to the Azure infrastructure + description: azure contains settings specific to the Azure infrastructure provider. type: object baremetal: - description: BareMetal contains settings specific to the BareMetal + description: baremetal contains settings specific to the BareMetal platform. properties: apiServerInternalIPs: @@ -198,7 +198,7 @@ spec: - message: ingressIPs list is required once set rule: '!has(oldSelf.ingressIPs) || has(self.ingressIPs)' equinixMetal: - description: EquinixMetal contains settings specific to the Equinix + description: equinixMetal contains settings specific to the Equinix Metal infrastructure provider. type: object external: @@ -209,7 +209,7 @@ spec: platformName: default: Unknown description: |- - PlatformName holds the arbitrary string representing the infrastructure provider name, expected to be set at the installation time. + 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 x-kubernetes-validations: @@ -217,19 +217,19 @@ spec: rule: oldSelf == 'Unknown' || self == oldSelf type: object gcp: - description: GCP contains settings specific to the Google Cloud + description: gcp contains settings specific to the Google Cloud Platform infrastructure provider. type: object ibmcloud: - description: IBMCloud contains settings specific to the IBMCloud + description: ibmcloud contains settings specific to the IBMCloud infrastructure provider. type: object kubevirt: - description: Kubevirt contains settings specific to the kubevirt + description: kubevirt contains settings specific to the kubevirt infrastructure provider. type: object nutanix: - description: Nutanix contains settings specific to the Nutanix + description: nutanix contains settings specific to the Nutanix infrastructure provider. properties: failureDomains: @@ -419,7 +419,7 @@ spec: - prismElements type: object openstack: - description: OpenStack contains settings specific to the OpenStack + description: openstack contains settings specific to the OpenStack infrastructure provider. properties: apiServerInternalIPs: @@ -503,11 +503,11 @@ spec: - message: ingressIPs list is required once set rule: '!has(oldSelf.ingressIPs) || has(self.ingressIPs)' ovirt: - description: Ovirt contains settings specific to the oVirt infrastructure + description: ovirt contains settings specific to the oVirt infrastructure provider. type: object powervs: - description: PowerVS contains settings specific to the IBM Power + description: powervs contains settings specific to the IBM Power Systems Virtual Servers infrastructure provider. properties: serviceEndpoints: @@ -589,7 +589,7 @@ spec: - External type: string vsphere: - description: VSphere contains settings specific to the VSphere + description: vsphere contains settings specific to the VSphere infrastructure provider. properties: apiServerInternalIPs: @@ -674,7 +674,7 @@ spec: minLength: 1 type: string topology: - description: Topology describes a given failure domain + description: topology describes a given failure domain using vSphere constructs properties: computeCluster: @@ -1139,7 +1139,7 @@ spec: infrastructure provider. properties: alibabaCloud: - description: AlibabaCloud contains settings specific to the Alibaba + description: alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. properties: region: @@ -1182,7 +1182,7 @@ spec: - region type: object aws: - description: AWS contains settings specific to the Amazon Web + description: aws contains settings specific to the Amazon Web Services infrastructure provider. properties: cloudLoadBalancerConfig: @@ -1327,7 +1327,7 @@ spec: x-kubernetes-list-type: atomic serviceEndpoints: description: |- - ServiceEndpoints list contains custom endpoints which will override default + serviceEndpoints list contains custom endpoints which will override default service endpoint of AWS Services. There must be only one ServiceEndpoint for a service. items: @@ -1354,7 +1354,7 @@ spec: x-kubernetes-list-type: atomic type: object azure: - description: Azure contains settings specific to the Azure infrastructure + description: azure contains settings specific to the Azure infrastructure provider. properties: armEndpoint: @@ -1427,7 +1427,7 @@ spec: rule: '!has(oldSelf.resourceTags) && !has(self.resourceTags) || has(oldSelf.resourceTags) && has(self.resourceTags)' baremetal: - description: BareMetal contains settings specific to the BareMetal + description: baremetal contains settings specific to the BareMetal platform. properties: apiServerInternalIP: @@ -1537,7 +1537,7 @@ spec: type: string type: object equinixMetal: - description: EquinixMetal contains settings specific to the Equinix + description: equinixMetal contains settings specific to the Equinix Metal infrastructure provider. properties: apiServerInternalIP: @@ -1554,7 +1554,7 @@ spec: type: string type: object external: - description: External contains settings specific to the generic + description: external contains settings specific to the generic External infrastructure provider. properties: cloudControllerManager: @@ -1593,7 +1593,7 @@ spec: once set rule: has(self.cloudControllerManager) == has(oldSelf.cloudControllerManager) gcp: - description: GCP contains settings specific to the Google Cloud + description: gcp contains settings specific to the Google Cloud Platform infrastructure provider. properties: cloudLoadBalancerConfig: @@ -1816,28 +1816,28 @@ spec: rule: '!has(oldSelf.resourceTags) && !has(self.resourceTags) || has(oldSelf.resourceTags) && has(self.resourceTags)' ibmcloud: - description: IBMCloud contains settings specific to the IBMCloud + description: ibmcloud contains settings specific to the IBMCloud infrastructure provider. properties: cisInstanceCRN: description: |- - CISInstanceCRN is the CRN of the Cloud Internet Services instance managing + 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 + 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 + description: location is where the cluster has been deployed type: string providerType: - description: ProviderType indicates the type of cluster that + description: providerType indicates the type of cluster that was created type: string resourceGroupName: - description: ResourceGroupName is the Resource Group for new + description: resourceGroupName is the Resource Group for new IBMCloud resources created for the cluster. type: string serviceEndpoints: @@ -1892,7 +1892,7 @@ spec: x-kubernetes-list-type: map type: object kubevirt: - description: Kubevirt contains settings specific to the kubevirt + description: kubevirt contains settings specific to the kubevirt infrastructure provider. properties: apiServerInternalIP: @@ -1909,7 +1909,7 @@ spec: type: string type: object nutanix: - description: Nutanix contains settings specific to the Nutanix + description: nutanix contains settings specific to the Nutanix infrastructure provider. properties: apiServerInternalIP: @@ -1993,7 +1993,7 @@ spec: type: object type: object openstack: - description: OpenStack contains settings specific to the OpenStack + description: openstack contains settings specific to the OpenStack infrastructure provider. properties: apiServerInternalIP: @@ -2108,7 +2108,7 @@ spec: type: string type: object ovirt: - description: Ovirt contains settings specific to the oVirt infrastructure + description: ovirt contains settings specific to the oVirt infrastructure provider. properties: apiServerInternalIP: @@ -2196,17 +2196,17 @@ spec: type: string type: object powervs: - description: PowerVS contains settings specific to the Power Systems + description: powervs contains settings specific to the Power Systems Virtual Servers infrastructure provider. properties: cisInstanceCRN: description: |- - CISInstanceCRN is the CRN of the Cloud Internet Services instance managing + 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 + dnsInstanceCRN is the CRN of the DNS Services instance managing the DNS zone for the cluster's base domain type: string region: @@ -2316,7 +2316,7 @@ spec: - External type: string vsphere: - description: VSphere contains settings specific to the VSphere + description: vsphere contains settings specific to the VSphere infrastructure provider. properties: apiServerInternalIP: diff --git a/payload-manifests/crds/0000_10_config-operator_01_infrastructures-Default.crd.yaml b/payload-manifests/crds/0000_10_config-operator_01_infrastructures-Default.crd.yaml index 9a9c2e66b59..55ec17de53a 100644 --- a/payload-manifests/crds/0000_10_config-operator_01_infrastructures-Default.crd.yaml +++ b/payload-manifests/crds/0000_10_config-operator_01_infrastructures-Default.crd.yaml @@ -62,7 +62,7 @@ spec: All the clients are expected to use the generated ConfigMap only. properties: key: - description: Key allows pointing to a specific key/value inside + description: key allows pointing to a specific key/value inside of the configmap. This is useful for logical file references. type: string name: @@ -74,11 +74,11 @@ spec: infrastructure provider. properties: alibabaCloud: - description: AlibabaCloud contains settings specific to the Alibaba + description: alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. type: object aws: - description: AWS contains settings specific to the Amazon Web + description: aws contains settings specific to the Amazon Web Services infrastructure provider. properties: serviceEndpoints: @@ -110,11 +110,11 @@ spec: x-kubernetes-list-type: atomic type: object azure: - description: Azure contains settings specific to the Azure infrastructure + description: azure contains settings specific to the Azure infrastructure provider. type: object baremetal: - description: BareMetal contains settings specific to the BareMetal + description: baremetal contains settings specific to the BareMetal platform. properties: apiServerInternalIPs: @@ -198,7 +198,7 @@ spec: - message: ingressIPs list is required once set rule: '!has(oldSelf.ingressIPs) || has(self.ingressIPs)' equinixMetal: - description: EquinixMetal contains settings specific to the Equinix + description: equinixMetal contains settings specific to the Equinix Metal infrastructure provider. type: object external: @@ -209,7 +209,7 @@ spec: platformName: default: Unknown description: |- - PlatformName holds the arbitrary string representing the infrastructure provider name, expected to be set at the installation time. + 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 x-kubernetes-validations: @@ -217,19 +217,19 @@ spec: rule: oldSelf == 'Unknown' || self == oldSelf type: object gcp: - description: GCP contains settings specific to the Google Cloud + description: gcp contains settings specific to the Google Cloud Platform infrastructure provider. type: object ibmcloud: - description: IBMCloud contains settings specific to the IBMCloud + description: ibmcloud contains settings specific to the IBMCloud infrastructure provider. type: object kubevirt: - description: Kubevirt contains settings specific to the kubevirt + description: kubevirt contains settings specific to the kubevirt infrastructure provider. type: object nutanix: - description: Nutanix contains settings specific to the Nutanix + description: nutanix contains settings specific to the Nutanix infrastructure provider. properties: failureDomains: @@ -415,7 +415,7 @@ spec: - prismElements type: object openstack: - description: OpenStack contains settings specific to the OpenStack + description: openstack contains settings specific to the OpenStack infrastructure provider. properties: apiServerInternalIPs: @@ -499,11 +499,11 @@ spec: - message: ingressIPs list is required once set rule: '!has(oldSelf.ingressIPs) || has(self.ingressIPs)' ovirt: - description: Ovirt contains settings specific to the oVirt infrastructure + description: ovirt contains settings specific to the oVirt infrastructure provider. type: object powervs: - description: PowerVS contains settings specific to the IBM Power + description: powervs contains settings specific to the IBM Power Systems Virtual Servers infrastructure provider. properties: serviceEndpoints: @@ -585,7 +585,7 @@ spec: - External type: string vsphere: - description: VSphere contains settings specific to the VSphere + description: vsphere contains settings specific to the VSphere infrastructure provider. properties: apiServerInternalIPs: @@ -670,7 +670,7 @@ spec: minLength: 1 type: string topology: - description: Topology describes a given failure domain + description: topology describes a given failure domain using vSphere constructs properties: computeCluster: @@ -1124,7 +1124,7 @@ spec: infrastructure provider. properties: alibabaCloud: - description: AlibabaCloud contains settings specific to the Alibaba + description: alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. properties: region: @@ -1167,7 +1167,7 @@ spec: - region type: object aws: - description: AWS contains settings specific to the Amazon Web + description: aws contains settings specific to the Amazon Web Services infrastructure provider. properties: region: @@ -1208,7 +1208,7 @@ spec: x-kubernetes-list-type: atomic serviceEndpoints: description: |- - ServiceEndpoints list contains custom endpoints which will override default + serviceEndpoints list contains custom endpoints which will override default service endpoint of AWS Services. There must be only one ServiceEndpoint for a service. items: @@ -1235,7 +1235,7 @@ spec: x-kubernetes-list-type: atomic type: object azure: - description: Azure contains settings specific to the Azure infrastructure + description: azure contains settings specific to the Azure infrastructure provider. properties: armEndpoint: @@ -1308,7 +1308,7 @@ spec: rule: '!has(oldSelf.resourceTags) && !has(self.resourceTags) || has(oldSelf.resourceTags) && has(self.resourceTags)' baremetal: - description: BareMetal contains settings specific to the BareMetal + description: baremetal contains settings specific to the BareMetal platform. properties: apiServerInternalIP: @@ -1418,7 +1418,7 @@ spec: type: string type: object equinixMetal: - description: EquinixMetal contains settings specific to the Equinix + description: equinixMetal contains settings specific to the Equinix Metal infrastructure provider. properties: apiServerInternalIP: @@ -1435,7 +1435,7 @@ spec: type: string type: object external: - description: External contains settings specific to the generic + description: external contains settings specific to the generic External infrastructure provider. properties: cloudControllerManager: @@ -1474,7 +1474,7 @@ spec: once set rule: has(self.cloudControllerManager) == has(oldSelf.cloudControllerManager) gcp: - description: GCP contains settings specific to the Google Cloud + description: gcp contains settings specific to the Google Cloud Platform infrastructure provider. properties: projectID: @@ -1593,28 +1593,28 @@ spec: rule: '!has(oldSelf.resourceTags) && !has(self.resourceTags) || has(oldSelf.resourceTags) && has(self.resourceTags)' ibmcloud: - description: IBMCloud contains settings specific to the IBMCloud + description: ibmcloud contains settings specific to the IBMCloud infrastructure provider. properties: cisInstanceCRN: description: |- - CISInstanceCRN is the CRN of the Cloud Internet Services instance managing + 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 + 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 + description: location is where the cluster has been deployed type: string providerType: - description: ProviderType indicates the type of cluster that + description: providerType indicates the type of cluster that was created type: string resourceGroupName: - description: ResourceGroupName is the Resource Group for new + description: resourceGroupName is the Resource Group for new IBMCloud resources created for the cluster. type: string serviceEndpoints: @@ -1669,7 +1669,7 @@ spec: x-kubernetes-list-type: map type: object kubevirt: - description: Kubevirt contains settings specific to the kubevirt + description: kubevirt contains settings specific to the kubevirt infrastructure provider. properties: apiServerInternalIP: @@ -1686,7 +1686,7 @@ spec: type: string type: object nutanix: - description: Nutanix contains settings specific to the Nutanix + description: nutanix contains settings specific to the Nutanix infrastructure provider. properties: apiServerInternalIP: @@ -1770,7 +1770,7 @@ spec: type: object type: object openstack: - description: OpenStack contains settings specific to the OpenStack + description: openstack contains settings specific to the OpenStack infrastructure provider. properties: apiServerInternalIP: @@ -1885,7 +1885,7 @@ spec: type: string type: object ovirt: - description: Ovirt contains settings specific to the oVirt infrastructure + description: ovirt contains settings specific to the oVirt infrastructure provider. properties: apiServerInternalIP: @@ -1973,17 +1973,17 @@ spec: type: string type: object powervs: - description: PowerVS contains settings specific to the Power Systems + description: powervs contains settings specific to the Power Systems Virtual Servers infrastructure provider. properties: cisInstanceCRN: description: |- - CISInstanceCRN is the CRN of the Cloud Internet Services instance managing + 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 + dnsInstanceCRN is the CRN of the DNS Services instance managing the DNS zone for the cluster's base domain type: string region: @@ -2093,7 +2093,7 @@ spec: - External type: string vsphere: - description: VSphere contains settings specific to the VSphere + description: vsphere contains settings specific to the VSphere infrastructure provider. properties: apiServerInternalIP: diff --git a/payload-manifests/crds/0000_10_config-operator_01_infrastructures-DevPreviewNoUpgrade.crd.yaml b/payload-manifests/crds/0000_10_config-operator_01_infrastructures-DevPreviewNoUpgrade.crd.yaml index a6a1bc5c97e..892e64a4a75 100644 --- a/payload-manifests/crds/0000_10_config-operator_01_infrastructures-DevPreviewNoUpgrade.crd.yaml +++ b/payload-manifests/crds/0000_10_config-operator_01_infrastructures-DevPreviewNoUpgrade.crd.yaml @@ -62,7 +62,7 @@ spec: All the clients are expected to use the generated ConfigMap only. properties: key: - description: Key allows pointing to a specific key/value inside + description: key allows pointing to a specific key/value inside of the configmap. This is useful for logical file references. type: string name: @@ -74,11 +74,11 @@ spec: infrastructure provider. properties: alibabaCloud: - description: AlibabaCloud contains settings specific to the Alibaba + description: alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. type: object aws: - description: AWS contains settings specific to the Amazon Web + description: aws contains settings specific to the Amazon Web Services infrastructure provider. properties: serviceEndpoints: @@ -110,11 +110,11 @@ spec: x-kubernetes-list-type: atomic type: object azure: - description: Azure contains settings specific to the Azure infrastructure + description: azure contains settings specific to the Azure infrastructure provider. type: object baremetal: - description: BareMetal contains settings specific to the BareMetal + description: baremetal contains settings specific to the BareMetal platform. properties: apiServerInternalIPs: @@ -198,7 +198,7 @@ spec: - message: ingressIPs list is required once set rule: '!has(oldSelf.ingressIPs) || has(self.ingressIPs)' equinixMetal: - description: EquinixMetal contains settings specific to the Equinix + description: equinixMetal contains settings specific to the Equinix Metal infrastructure provider. type: object external: @@ -209,7 +209,7 @@ spec: platformName: default: Unknown description: |- - PlatformName holds the arbitrary string representing the infrastructure provider name, expected to be set at the installation time. + 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 x-kubernetes-validations: @@ -217,19 +217,19 @@ spec: rule: oldSelf == 'Unknown' || self == oldSelf type: object gcp: - description: GCP contains settings specific to the Google Cloud + description: gcp contains settings specific to the Google Cloud Platform infrastructure provider. type: object ibmcloud: - description: IBMCloud contains settings specific to the IBMCloud + description: ibmcloud contains settings specific to the IBMCloud infrastructure provider. type: object kubevirt: - description: Kubevirt contains settings specific to the kubevirt + description: kubevirt contains settings specific to the kubevirt infrastructure provider. type: object nutanix: - description: Nutanix contains settings specific to the Nutanix + description: nutanix contains settings specific to the Nutanix infrastructure provider. properties: failureDomains: @@ -419,7 +419,7 @@ spec: - prismElements type: object openstack: - description: OpenStack contains settings specific to the OpenStack + description: openstack contains settings specific to the OpenStack infrastructure provider. properties: apiServerInternalIPs: @@ -503,11 +503,11 @@ spec: - message: ingressIPs list is required once set rule: '!has(oldSelf.ingressIPs) || has(self.ingressIPs)' ovirt: - description: Ovirt contains settings specific to the oVirt infrastructure + description: ovirt contains settings specific to the oVirt infrastructure provider. type: object powervs: - description: PowerVS contains settings specific to the IBM Power + description: powervs contains settings specific to the IBM Power Systems Virtual Servers infrastructure provider. properties: serviceEndpoints: @@ -589,7 +589,7 @@ spec: - External type: string vsphere: - description: VSphere contains settings specific to the VSphere + description: vsphere contains settings specific to the VSphere infrastructure provider. properties: apiServerInternalIPs: @@ -674,7 +674,7 @@ spec: minLength: 1 type: string topology: - description: Topology describes a given failure domain + description: topology describes a given failure domain using vSphere constructs properties: computeCluster: @@ -1139,7 +1139,7 @@ spec: infrastructure provider. properties: alibabaCloud: - description: AlibabaCloud contains settings specific to the Alibaba + description: alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. properties: region: @@ -1182,7 +1182,7 @@ spec: - region type: object aws: - description: AWS contains settings specific to the Amazon Web + description: aws contains settings specific to the Amazon Web Services infrastructure provider. properties: cloudLoadBalancerConfig: @@ -1327,7 +1327,7 @@ spec: x-kubernetes-list-type: atomic serviceEndpoints: description: |- - ServiceEndpoints list contains custom endpoints which will override default + serviceEndpoints list contains custom endpoints which will override default service endpoint of AWS Services. There must be only one ServiceEndpoint for a service. items: @@ -1354,7 +1354,7 @@ spec: x-kubernetes-list-type: atomic type: object azure: - description: Azure contains settings specific to the Azure infrastructure + description: azure contains settings specific to the Azure infrastructure provider. properties: armEndpoint: @@ -1427,7 +1427,7 @@ spec: rule: '!has(oldSelf.resourceTags) && !has(self.resourceTags) || has(oldSelf.resourceTags) && has(self.resourceTags)' baremetal: - description: BareMetal contains settings specific to the BareMetal + description: baremetal contains settings specific to the BareMetal platform. properties: apiServerInternalIP: @@ -1537,7 +1537,7 @@ spec: type: string type: object equinixMetal: - description: EquinixMetal contains settings specific to the Equinix + description: equinixMetal contains settings specific to the Equinix Metal infrastructure provider. properties: apiServerInternalIP: @@ -1554,7 +1554,7 @@ spec: type: string type: object external: - description: External contains settings specific to the generic + description: external contains settings specific to the generic External infrastructure provider. properties: cloudControllerManager: @@ -1593,7 +1593,7 @@ spec: once set rule: has(self.cloudControllerManager) == has(oldSelf.cloudControllerManager) gcp: - description: GCP contains settings specific to the Google Cloud + description: gcp contains settings specific to the Google Cloud Platform infrastructure provider. properties: cloudLoadBalancerConfig: @@ -1816,28 +1816,28 @@ spec: rule: '!has(oldSelf.resourceTags) && !has(self.resourceTags) || has(oldSelf.resourceTags) && has(self.resourceTags)' ibmcloud: - description: IBMCloud contains settings specific to the IBMCloud + description: ibmcloud contains settings specific to the IBMCloud infrastructure provider. properties: cisInstanceCRN: description: |- - CISInstanceCRN is the CRN of the Cloud Internet Services instance managing + 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 + 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 + description: location is where the cluster has been deployed type: string providerType: - description: ProviderType indicates the type of cluster that + description: providerType indicates the type of cluster that was created type: string resourceGroupName: - description: ResourceGroupName is the Resource Group for new + description: resourceGroupName is the Resource Group for new IBMCloud resources created for the cluster. type: string serviceEndpoints: @@ -1892,7 +1892,7 @@ spec: x-kubernetes-list-type: map type: object kubevirt: - description: Kubevirt contains settings specific to the kubevirt + description: kubevirt contains settings specific to the kubevirt infrastructure provider. properties: apiServerInternalIP: @@ -1909,7 +1909,7 @@ spec: type: string type: object nutanix: - description: Nutanix contains settings specific to the Nutanix + description: nutanix contains settings specific to the Nutanix infrastructure provider. properties: apiServerInternalIP: @@ -1993,7 +1993,7 @@ spec: type: object type: object openstack: - description: OpenStack contains settings specific to the OpenStack + description: openstack contains settings specific to the OpenStack infrastructure provider. properties: apiServerInternalIP: @@ -2108,7 +2108,7 @@ spec: type: string type: object ovirt: - description: Ovirt contains settings specific to the oVirt infrastructure + description: ovirt contains settings specific to the oVirt infrastructure provider. properties: apiServerInternalIP: @@ -2196,17 +2196,17 @@ spec: type: string type: object powervs: - description: PowerVS contains settings specific to the Power Systems + description: powervs contains settings specific to the Power Systems Virtual Servers infrastructure provider. properties: cisInstanceCRN: description: |- - CISInstanceCRN is the CRN of the Cloud Internet Services instance managing + 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 + dnsInstanceCRN is the CRN of the DNS Services instance managing the DNS zone for the cluster's base domain type: string region: @@ -2316,7 +2316,7 @@ spec: - External type: string vsphere: - description: VSphere contains settings specific to the VSphere + description: vsphere contains settings specific to the VSphere infrastructure provider. properties: apiServerInternalIP: diff --git a/payload-manifests/crds/0000_10_config-operator_01_infrastructures-TechPreviewNoUpgrade.crd.yaml b/payload-manifests/crds/0000_10_config-operator_01_infrastructures-TechPreviewNoUpgrade.crd.yaml index 2be308fe0ff..cec1689db66 100644 --- a/payload-manifests/crds/0000_10_config-operator_01_infrastructures-TechPreviewNoUpgrade.crd.yaml +++ b/payload-manifests/crds/0000_10_config-operator_01_infrastructures-TechPreviewNoUpgrade.crd.yaml @@ -62,7 +62,7 @@ spec: All the clients are expected to use the generated ConfigMap only. properties: key: - description: Key allows pointing to a specific key/value inside + description: key allows pointing to a specific key/value inside of the configmap. This is useful for logical file references. type: string name: @@ -74,11 +74,11 @@ spec: infrastructure provider. properties: alibabaCloud: - description: AlibabaCloud contains settings specific to the Alibaba + description: alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. type: object aws: - description: AWS contains settings specific to the Amazon Web + description: aws contains settings specific to the Amazon Web Services infrastructure provider. properties: serviceEndpoints: @@ -110,11 +110,11 @@ spec: x-kubernetes-list-type: atomic type: object azure: - description: Azure contains settings specific to the Azure infrastructure + description: azure contains settings specific to the Azure infrastructure provider. type: object baremetal: - description: BareMetal contains settings specific to the BareMetal + description: baremetal contains settings specific to the BareMetal platform. properties: apiServerInternalIPs: @@ -198,7 +198,7 @@ spec: - message: ingressIPs list is required once set rule: '!has(oldSelf.ingressIPs) || has(self.ingressIPs)' equinixMetal: - description: EquinixMetal contains settings specific to the Equinix + description: equinixMetal contains settings specific to the Equinix Metal infrastructure provider. type: object external: @@ -209,7 +209,7 @@ spec: platformName: default: Unknown description: |- - PlatformName holds the arbitrary string representing the infrastructure provider name, expected to be set at the installation time. + 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 x-kubernetes-validations: @@ -217,19 +217,19 @@ spec: rule: oldSelf == 'Unknown' || self == oldSelf type: object gcp: - description: GCP contains settings specific to the Google Cloud + description: gcp contains settings specific to the Google Cloud Platform infrastructure provider. type: object ibmcloud: - description: IBMCloud contains settings specific to the IBMCloud + description: ibmcloud contains settings specific to the IBMCloud infrastructure provider. type: object kubevirt: - description: Kubevirt contains settings specific to the kubevirt + description: kubevirt contains settings specific to the kubevirt infrastructure provider. type: object nutanix: - description: Nutanix contains settings specific to the Nutanix + description: nutanix contains settings specific to the Nutanix infrastructure provider. properties: failureDomains: @@ -419,7 +419,7 @@ spec: - prismElements type: object openstack: - description: OpenStack contains settings specific to the OpenStack + description: openstack contains settings specific to the OpenStack infrastructure provider. properties: apiServerInternalIPs: @@ -503,11 +503,11 @@ spec: - message: ingressIPs list is required once set rule: '!has(oldSelf.ingressIPs) || has(self.ingressIPs)' ovirt: - description: Ovirt contains settings specific to the oVirt infrastructure + description: ovirt contains settings specific to the oVirt infrastructure provider. type: object powervs: - description: PowerVS contains settings specific to the IBM Power + description: powervs contains settings specific to the IBM Power Systems Virtual Servers infrastructure provider. properties: serviceEndpoints: @@ -589,7 +589,7 @@ spec: - External type: string vsphere: - description: VSphere contains settings specific to the VSphere + description: vsphere contains settings specific to the VSphere infrastructure provider. properties: apiServerInternalIPs: @@ -674,7 +674,7 @@ spec: minLength: 1 type: string topology: - description: Topology describes a given failure domain + description: topology describes a given failure domain using vSphere constructs properties: computeCluster: @@ -1139,7 +1139,7 @@ spec: infrastructure provider. properties: alibabaCloud: - description: AlibabaCloud contains settings specific to the Alibaba + description: alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. properties: region: @@ -1182,7 +1182,7 @@ spec: - region type: object aws: - description: AWS contains settings specific to the Amazon Web + description: aws contains settings specific to the Amazon Web Services infrastructure provider. properties: cloudLoadBalancerConfig: @@ -1327,7 +1327,7 @@ spec: x-kubernetes-list-type: atomic serviceEndpoints: description: |- - ServiceEndpoints list contains custom endpoints which will override default + serviceEndpoints list contains custom endpoints which will override default service endpoint of AWS Services. There must be only one ServiceEndpoint for a service. items: @@ -1354,7 +1354,7 @@ spec: x-kubernetes-list-type: atomic type: object azure: - description: Azure contains settings specific to the Azure infrastructure + description: azure contains settings specific to the Azure infrastructure provider. properties: armEndpoint: @@ -1427,7 +1427,7 @@ spec: rule: '!has(oldSelf.resourceTags) && !has(self.resourceTags) || has(oldSelf.resourceTags) && has(self.resourceTags)' baremetal: - description: BareMetal contains settings specific to the BareMetal + description: baremetal contains settings specific to the BareMetal platform. properties: apiServerInternalIP: @@ -1537,7 +1537,7 @@ spec: type: string type: object equinixMetal: - description: EquinixMetal contains settings specific to the Equinix + description: equinixMetal contains settings specific to the Equinix Metal infrastructure provider. properties: apiServerInternalIP: @@ -1554,7 +1554,7 @@ spec: type: string type: object external: - description: External contains settings specific to the generic + description: external contains settings specific to the generic External infrastructure provider. properties: cloudControllerManager: @@ -1593,7 +1593,7 @@ spec: once set rule: has(self.cloudControllerManager) == has(oldSelf.cloudControllerManager) gcp: - description: GCP contains settings specific to the Google Cloud + description: gcp contains settings specific to the Google Cloud Platform infrastructure provider. properties: cloudLoadBalancerConfig: @@ -1816,28 +1816,28 @@ spec: rule: '!has(oldSelf.resourceTags) && !has(self.resourceTags) || has(oldSelf.resourceTags) && has(self.resourceTags)' ibmcloud: - description: IBMCloud contains settings specific to the IBMCloud + description: ibmcloud contains settings specific to the IBMCloud infrastructure provider. properties: cisInstanceCRN: description: |- - CISInstanceCRN is the CRN of the Cloud Internet Services instance managing + 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 + 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 + description: location is where the cluster has been deployed type: string providerType: - description: ProviderType indicates the type of cluster that + description: providerType indicates the type of cluster that was created type: string resourceGroupName: - description: ResourceGroupName is the Resource Group for new + description: resourceGroupName is the Resource Group for new IBMCloud resources created for the cluster. type: string serviceEndpoints: @@ -1892,7 +1892,7 @@ spec: x-kubernetes-list-type: map type: object kubevirt: - description: Kubevirt contains settings specific to the kubevirt + description: kubevirt contains settings specific to the kubevirt infrastructure provider. properties: apiServerInternalIP: @@ -1909,7 +1909,7 @@ spec: type: string type: object nutanix: - description: Nutanix contains settings specific to the Nutanix + description: nutanix contains settings specific to the Nutanix infrastructure provider. properties: apiServerInternalIP: @@ -1993,7 +1993,7 @@ spec: type: object type: object openstack: - description: OpenStack contains settings specific to the OpenStack + description: openstack contains settings specific to the OpenStack infrastructure provider. properties: apiServerInternalIP: @@ -2108,7 +2108,7 @@ spec: type: string type: object ovirt: - description: Ovirt contains settings specific to the oVirt infrastructure + description: ovirt contains settings specific to the oVirt infrastructure provider. properties: apiServerInternalIP: @@ -2196,17 +2196,17 @@ spec: type: string type: object powervs: - description: PowerVS contains settings specific to the Power Systems + description: powervs contains settings specific to the Power Systems Virtual Servers infrastructure provider. properties: cisInstanceCRN: description: |- - CISInstanceCRN is the CRN of the Cloud Internet Services instance managing + 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 + dnsInstanceCRN is the CRN of the DNS Services instance managing the DNS zone for the cluster's base domain type: string region: @@ -2316,7 +2316,7 @@ spec: - External type: string vsphere: - description: VSphere contains settings specific to the VSphere + description: vsphere contains settings specific to the VSphere infrastructure provider. properties: apiServerInternalIP: diff --git a/payload-manifests/crds/0000_10_config-operator_01_networks.crd.yaml b/payload-manifests/crds/0000_10_config-operator_01_networks.crd.yaml index 49db650d7aa..fac73b78fa9 100644 --- a/payload-manifests/crds/0000_10_config-operator_01_networks.crd.yaml +++ b/payload-manifests/crds/0000_10_config-operator_01_networks.crd.yaml @@ -260,7 +260,7 @@ spec: type: object networkType: description: |- - NetworkType is the plugin that is to be deployed (e.g. OVNKubernetes). + 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: @@ -318,7 +318,7 @@ spec: type: array x-kubernetes-list-type: atomic clusterNetworkMTU: - description: ClusterNetworkMTU is the MTU for inter-pod networking. + description: clusterNetworkMTU is the MTU for inter-pod networking. type: integer conditions: description: |- @@ -383,13 +383,13 @@ spec: - type x-kubernetes-list-type: map migration: - description: Migration contains the cluster network migration configuration. + description: migration contains the cluster network migration configuration. properties: mtu: - description: MTU is the MTU configuration that is being deployed. + description: mtu is the MTU configuration that is being deployed. properties: machine: - description: Machine contains MTU migration configuration + description: machine contains MTU migration configuration for the machine's uplink. properties: from: @@ -404,7 +404,7 @@ spec: type: integer type: object network: - description: Network contains MTU migration configuration + description: network contains MTU migration configuration for the default network. properties: from: @@ -421,13 +421,13 @@ spec: type: object networkType: description: |- - NetworkType is the target plugin that is being deployed. + 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 type: object networkType: - description: NetworkType is the plugin that is deployed (e.g. OVNKubernetes). + description: networkType is the plugin that is deployed (e.g. OVNKubernetes). type: string serviceNetwork: description: |- diff --git a/payload-manifests/crds/0000_10_config-operator_01_nodes-CustomNoUpgrade.crd.yaml b/payload-manifests/crds/0000_10_config-operator_01_nodes-CustomNoUpgrade.crd.yaml index 469400577ae..776be2eeb6d 100644 --- a/payload-manifests/crds/0000_10_config-operator_01_nodes-CustomNoUpgrade.crd.yaml +++ b/payload-manifests/crds/0000_10_config-operator_01_nodes-CustomNoUpgrade.crd.yaml @@ -47,7 +47,7 @@ spec: description: spec holds user settable values for configuration properties: cgroupMode: - description: CgroupMode determines the cgroups version on the node + description: cgroupMode determines the cgroups version on the node enum: - v1 - v2 @@ -76,7 +76,7 @@ spec: rule: self == "" || self.matches('^[0-9]*.[0-9]*.[0-9]*$') workerLatencyProfile: description: |- - WorkerLatencyProfile determins the how fast the kubelet is updating + workerLatencyProfile determins the how fast the kubelet is updating the status and corresponding reaction of the cluster enum: - Default diff --git a/payload-manifests/crds/0000_10_config-operator_01_nodes-Default.crd.yaml b/payload-manifests/crds/0000_10_config-operator_01_nodes-Default.crd.yaml index b79a394c6e1..a4d69857db0 100644 --- a/payload-manifests/crds/0000_10_config-operator_01_nodes-Default.crd.yaml +++ b/payload-manifests/crds/0000_10_config-operator_01_nodes-Default.crd.yaml @@ -47,7 +47,7 @@ spec: description: spec holds user settable values for configuration properties: cgroupMode: - description: CgroupMode determines the cgroups version on the node + description: cgroupMode determines the cgroups version on the node enum: - v1 - v2 @@ -55,7 +55,7 @@ spec: type: string workerLatencyProfile: description: |- - WorkerLatencyProfile determins the how fast the kubelet is updating + workerLatencyProfile determins the how fast the kubelet is updating the status and corresponding reaction of the cluster enum: - Default diff --git a/payload-manifests/crds/0000_10_config-operator_01_nodes-DevPreviewNoUpgrade.crd.yaml b/payload-manifests/crds/0000_10_config-operator_01_nodes-DevPreviewNoUpgrade.crd.yaml index 99b124d5728..00413af2e24 100644 --- a/payload-manifests/crds/0000_10_config-operator_01_nodes-DevPreviewNoUpgrade.crd.yaml +++ b/payload-manifests/crds/0000_10_config-operator_01_nodes-DevPreviewNoUpgrade.crd.yaml @@ -47,7 +47,7 @@ spec: description: spec holds user settable values for configuration properties: cgroupMode: - description: CgroupMode determines the cgroups version on the node + description: cgroupMode determines the cgroups version on the node enum: - v1 - v2 @@ -76,7 +76,7 @@ spec: rule: self == "" || self.matches('^[0-9]*.[0-9]*.[0-9]*$') workerLatencyProfile: description: |- - WorkerLatencyProfile determins the how fast the kubelet is updating + workerLatencyProfile determins the how fast the kubelet is updating the status and corresponding reaction of the cluster enum: - Default diff --git a/payload-manifests/crds/0000_10_config-operator_01_nodes-TechPreviewNoUpgrade.crd.yaml b/payload-manifests/crds/0000_10_config-operator_01_nodes-TechPreviewNoUpgrade.crd.yaml index 8db838df772..8504be1e39b 100644 --- a/payload-manifests/crds/0000_10_config-operator_01_nodes-TechPreviewNoUpgrade.crd.yaml +++ b/payload-manifests/crds/0000_10_config-operator_01_nodes-TechPreviewNoUpgrade.crd.yaml @@ -47,7 +47,7 @@ spec: description: spec holds user settable values for configuration properties: cgroupMode: - description: CgroupMode determines the cgroups version on the node + description: cgroupMode determines the cgroups version on the node enum: - v1 - v2 @@ -76,7 +76,7 @@ spec: rule: self == "" || self.matches('^[0-9]*.[0-9]*.[0-9]*$') workerLatencyProfile: description: |- - WorkerLatencyProfile determins the how fast the kubelet is updating + workerLatencyProfile determins the how fast the kubelet is updating the status and corresponding reaction of the cluster enum: - Default 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 index f557085f8fd..d058dd7dccc 100644 --- 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 @@ -72,7 +72,7 @@ spec: type: string mastersSchedulable: description: |- - MastersSchedulable allows masters nodes to be schedulable. When this flag is + 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. 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-Default.crd.yaml index cbfff13ab79..37abbe9a533 100644 --- a/payload-manifests/crds/0000_10_config-operator_01_schedulers-Default.crd.yaml +++ b/payload-manifests/crds/0000_10_config-operator_01_schedulers-Default.crd.yaml @@ -72,7 +72,7 @@ spec: type: string mastersSchedulable: description: |- - MastersSchedulable allows masters nodes to be schedulable. When this flag is + 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. 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 index 39aae9ecede..a62eb09733f 100644 --- 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 @@ -72,7 +72,7 @@ spec: type: string mastersSchedulable: description: |- - MastersSchedulable allows masters nodes to be schedulable. When this flag is + 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. 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 index 34b79b3f1fc..24fbbb3021f 100644 --- 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 @@ -72,7 +72,7 @@ spec: type: string mastersSchedulable: description: |- - MastersSchedulable allows masters nodes to be schedulable. When this flag is + 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. diff --git a/payload-manifests/crds/0000_10_control-plane-machine-set_01_controlplanemachinesets-CustomNoUpgrade.crd.yaml b/payload-manifests/crds/0000_10_control-plane-machine-set_01_controlplanemachinesets-CustomNoUpgrade.crd.yaml index 45750709c71..333432c038a 100644 --- a/payload-manifests/crds/0000_10_control-plane-machine-set_01_controlplanemachinesets-CustomNoUpgrade.crd.yaml +++ b/payload-manifests/crds/0000_10_control-plane-machine-set_01_controlplanemachinesets-CustomNoUpgrade.crd.yaml @@ -98,7 +98,7 @@ spec: replicas: default: 3 description: |- - Replicas defines how many Control Plane Machines should be + replicas defines how many Control Plane Machines should be created by this ControlPlaneMachineSet. This field is immutable and cannot be changed after cluster installation. @@ -168,7 +168,7 @@ spec: state: default: Inactive description: |- - State defines whether the ControlPlaneMachineSet is Active or Inactive. + 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 @@ -186,13 +186,13 @@ spec: default: type: RollingUpdate description: |- - Strategy defines how the ControlPlaneMachineSet will update + strategy defines how the ControlPlaneMachineSet will update Machines when it detects a change to the ProviderSpec. properties: type: default: RollingUpdate description: |- - Type defines the type of update strategy that should be + 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". @@ -203,12 +203,12 @@ spec: type: object template: description: |- - Template describes the Control Plane Machines that will be created + template describes the Control Plane Machines that will be created by this ControlPlaneMachineSet. properties: machineType: description: |- - MachineType determines the type of Machines that should be managed by the ControlPlaneMachineSet. + machineType determines the type of Machines that should be managed by the ControlPlaneMachineSet. Currently, the only valid value is machines_v1beta1_machine_openshift_io. enum: - machines_v1beta1_machine_openshift_io @@ -220,14 +220,14 @@ spec: properties: failureDomains: description: |- - FailureDomains is the list of failure domains (sometimes called + 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. properties: aws: - description: AWS configures failure domain information + description: aws configures failure domain information for the AWS platform. items: description: AWSFailureDomain configures failure domain @@ -235,32 +235,32 @@ spec: minProperties: 1 properties: placement: - description: Placement configures the placement + description: placement configures the placement information for this instance. properties: availabilityZone: - description: AvailabilityZone is the availability + description: availabilityZone is the availability zone of the instance. type: string required: - availabilityZone type: object subnet: - description: Subnet is a reference to the subnet + description: subnet is a reference to the subnet to use for this instance. properties: arn: - description: ARN of resource. + description: arn of resource. type: string filters: - description: Filters is a set of filters used + description: filters is a set of filters used to identify a resource. items: description: AWSResourceFilter is a filter used to identify an AWS resource properties: name: - description: Name of the filter. Filter + description: name of the filter. Filter names are case-sensitive. type: string values: @@ -276,10 +276,10 @@ spec: type: array x-kubernetes-list-type: atomic id: - description: ID of resource. + description: id of resource. type: string type: - description: Type determines how the reference + description: type determines how the reference will fetch the AWS resource. enum: - ID @@ -306,7 +306,7 @@ spec: type: array x-kubernetes-list-type: atomic azure: - description: Azure configures failure domain information + description: azure configures failure domain information for the Azure platform. items: description: AzureFailureDomain configures failure domain @@ -330,14 +330,14 @@ spec: type: array x-kubernetes-list-type: atomic gcp: - description: GCP configures failure domain information + description: gcp configures failure domain information for the GCP platform. items: description: GCPFailureDomain configures failure domain information for the GCP platform properties: zone: - description: Zone is the zone in which the GCP machine + description: zone is the zone in which the GCP machine provider will create the VM. type: string required: @@ -368,7 +368,7 @@ spec: - name x-kubernetes-list-type: map openstack: - description: OpenStack configures failure domain information + description: openstack configures failure domain information for the OpenStack platform. items: description: OpenStackFailureDomain configures failure @@ -427,7 +427,7 @@ spec: x-kubernetes-list-type: atomic platform: description: |- - Platform identifies the platform for which the FailureDomain represents. + platform identifies the platform for which the FailureDomain represents. Currently supported values are AWS, Azure, GCP, OpenStack, VSphere and Nutanix. enum: - "" @@ -507,7 +507,7 @@ spec: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + 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 @@ -543,7 +543,7 @@ spec: type: object spec: description: |- - Spec contains the desired configuration of the Control Plane Machines. + 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 @@ -566,12 +566,12 @@ spec: type: string lifecycleHooks: description: |- - LifecycleHooks allow users to pause operations on the machine at + lifecycleHooks allow users to pause operations on the machine at certain predefined points within the machine lifecycle. properties: preDrain: description: |- - PreDrain hooks prevent the machine from being drained. + preDrain hooks prevent the machine from being drained. This also blocks further lifecycle events, such as termination. items: description: LifecycleHook represents a single instance @@ -579,7 +579,7 @@ spec: properties: name: description: |- - Name defines a unique name for the lifcycle hook. + 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. @@ -589,7 +589,7 @@ spec: type: string owner: description: |- - Owner defines the owner of the lifecycle hook. + 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) @@ -607,7 +607,7 @@ spec: x-kubernetes-list-type: map preTerminate: description: |- - PreTerminate hooks prevent the machine from being terminated. + preTerminate hooks prevent the machine from being terminated. PreTerminate hooks be actioned after the Machine has been drained. items: description: LifecycleHook represents a single instance @@ -615,7 +615,7 @@ spec: properties: name: description: |- - Name defines a unique name for the lifcycle hook. + 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. @@ -625,7 +625,7 @@ spec: type: string owner: description: |- - Owner defines the owner of the lifecycle hook. + 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) @@ -652,14 +652,14 @@ spec: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + 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 generateName: description: |- - GenerateName is an optional prefix, used by the server, to generate a unique + 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. @@ -686,7 +686,7 @@ spec: type: object name: description: |- - Name must be unique within a namespace. Is required when creating resources, although + 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. @@ -695,7 +695,7 @@ spec: type: string namespace: description: |- - Namespace defines the space within each name must be unique. An empty namespace is + 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. @@ -763,7 +763,7 @@ spec: type: object providerID: description: |- - ProviderID is the identification ID of the machine provided by the provider. + 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 @@ -775,12 +775,12 @@ spec: be interfacing with cluster-api as generic provider. type: string providerSpec: - description: ProviderSpec details Provider-specific configuration + description: providerSpec details Provider-specific configuration to use during node creation. properties: value: description: |- - Value is an inlined, serialized representation of the resource + 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. @@ -851,7 +851,7 @@ spec: properties: conditions: description: |- - Conditions represents the observations of the ControlPlaneMachineSet's current state. + conditions represents the observations of the ControlPlaneMachineSet's current state. Known .status.conditions.type are: Available, Degraded and Progressing. items: description: Condition contains details for one aspect of the current @@ -913,14 +913,14 @@ spec: x-kubernetes-list-type: map observedGeneration: description: |- - ObservedGeneration is the most recent generation observed for this + 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. format: int64 type: integer readyReplicas: description: |- - ReadyReplicas is the number of Control Plane Machines created by the + 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. @@ -928,7 +928,7 @@ spec: type: integer replicas: description: |- - Replicas is the number of Control Plane Machines created by the + 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. @@ -936,7 +936,7 @@ spec: type: integer unavailableReplicas: description: |- - UnavailableReplicas is the number of Control Plane Machines that are + 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. @@ -944,7 +944,7 @@ spec: type: integer updatedReplicas: description: |- - UpdatedReplicas is the number of non-terminated Control Plane Machines + 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. diff --git a/payload-manifests/crds/0000_10_control-plane-machine-set_01_controlplanemachinesets-Default.crd.yaml b/payload-manifests/crds/0000_10_control-plane-machine-set_01_controlplanemachinesets-Default.crd.yaml index 94e7a9e0fb7..14e225767c8 100644 --- a/payload-manifests/crds/0000_10_control-plane-machine-set_01_controlplanemachinesets-Default.crd.yaml +++ b/payload-manifests/crds/0000_10_control-plane-machine-set_01_controlplanemachinesets-Default.crd.yaml @@ -78,7 +78,7 @@ spec: replicas: default: 3 description: |- - Replicas defines how many Control Plane Machines should be + replicas defines how many Control Plane Machines should be created by this ControlPlaneMachineSet. This field is immutable and cannot be changed after cluster installation. @@ -148,7 +148,7 @@ spec: state: default: Inactive description: |- - State defines whether the ControlPlaneMachineSet is Active or Inactive. + 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 @@ -166,13 +166,13 @@ spec: default: type: RollingUpdate description: |- - Strategy defines how the ControlPlaneMachineSet will update + strategy defines how the ControlPlaneMachineSet will update Machines when it detects a change to the ProviderSpec. properties: type: default: RollingUpdate description: |- - Type defines the type of update strategy that should be + 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". @@ -183,12 +183,12 @@ spec: type: object template: description: |- - Template describes the Control Plane Machines that will be created + template describes the Control Plane Machines that will be created by this ControlPlaneMachineSet. properties: machineType: description: |- - MachineType determines the type of Machines that should be managed by the ControlPlaneMachineSet. + machineType determines the type of Machines that should be managed by the ControlPlaneMachineSet. Currently, the only valid value is machines_v1beta1_machine_openshift_io. enum: - machines_v1beta1_machine_openshift_io @@ -200,14 +200,14 @@ spec: properties: failureDomains: description: |- - FailureDomains is the list of failure domains (sometimes called + 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. properties: aws: - description: AWS configures failure domain information + description: aws configures failure domain information for the AWS platform. items: description: AWSFailureDomain configures failure domain @@ -215,32 +215,32 @@ spec: minProperties: 1 properties: placement: - description: Placement configures the placement + description: placement configures the placement information for this instance. properties: availabilityZone: - description: AvailabilityZone is the availability + description: availabilityZone is the availability zone of the instance. type: string required: - availabilityZone type: object subnet: - description: Subnet is a reference to the subnet + description: subnet is a reference to the subnet to use for this instance. properties: arn: - description: ARN of resource. + description: arn of resource. type: string filters: - description: Filters is a set of filters used + description: filters is a set of filters used to identify a resource. items: description: AWSResourceFilter is a filter used to identify an AWS resource properties: name: - description: Name of the filter. Filter + description: name of the filter. Filter names are case-sensitive. type: string values: @@ -256,10 +256,10 @@ spec: type: array x-kubernetes-list-type: atomic id: - description: ID of resource. + description: id of resource. type: string type: - description: Type determines how the reference + description: type determines how the reference will fetch the AWS resource. enum: - ID @@ -286,7 +286,7 @@ spec: type: array x-kubernetes-list-type: atomic azure: - description: Azure configures failure domain information + description: azure configures failure domain information for the Azure platform. items: description: AzureFailureDomain configures failure domain @@ -310,14 +310,14 @@ spec: type: array x-kubernetes-list-type: atomic gcp: - description: GCP configures failure domain information + description: gcp configures failure domain information for the GCP platform. items: description: GCPFailureDomain configures failure domain information for the GCP platform properties: zone: - description: Zone is the zone in which the GCP machine + description: zone is the zone in which the GCP machine provider will create the VM. type: string required: @@ -348,7 +348,7 @@ spec: - name x-kubernetes-list-type: map openstack: - description: OpenStack configures failure domain information + description: openstack configures failure domain information for the OpenStack platform. items: description: OpenStackFailureDomain configures failure @@ -407,7 +407,7 @@ spec: x-kubernetes-list-type: atomic platform: description: |- - Platform identifies the platform for which the FailureDomain represents. + platform identifies the platform for which the FailureDomain represents. Currently supported values are AWS, Azure, GCP, OpenStack, VSphere and Nutanix. enum: - "" @@ -487,7 +487,7 @@ spec: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + 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 @@ -523,7 +523,7 @@ spec: type: object spec: description: |- - Spec contains the desired configuration of the Control Plane Machines. + 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 @@ -532,12 +532,12 @@ spec: properties: lifecycleHooks: description: |- - LifecycleHooks allow users to pause operations on the machine at + lifecycleHooks allow users to pause operations on the machine at certain predefined points within the machine lifecycle. properties: preDrain: description: |- - PreDrain hooks prevent the machine from being drained. + preDrain hooks prevent the machine from being drained. This also blocks further lifecycle events, such as termination. items: description: LifecycleHook represents a single instance @@ -545,7 +545,7 @@ spec: properties: name: description: |- - Name defines a unique name for the lifcycle hook. + 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. @@ -555,7 +555,7 @@ spec: type: string owner: description: |- - Owner defines the owner of the lifecycle hook. + 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) @@ -573,7 +573,7 @@ spec: x-kubernetes-list-type: map preTerminate: description: |- - PreTerminate hooks prevent the machine from being terminated. + preTerminate hooks prevent the machine from being terminated. PreTerminate hooks be actioned after the Machine has been drained. items: description: LifecycleHook represents a single instance @@ -581,7 +581,7 @@ spec: properties: name: description: |- - Name defines a unique name for the lifcycle hook. + 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. @@ -591,7 +591,7 @@ spec: type: string owner: description: |- - Owner defines the owner of the lifecycle hook. + 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) @@ -618,14 +618,14 @@ spec: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + 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 generateName: description: |- - GenerateName is an optional prefix, used by the server, to generate a unique + 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. @@ -652,7 +652,7 @@ spec: type: object name: description: |- - Name must be unique within a namespace. Is required when creating resources, although + 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. @@ -661,7 +661,7 @@ spec: type: string namespace: description: |- - Namespace defines the space within each name must be unique. An empty namespace is + 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. @@ -729,7 +729,7 @@ spec: type: object providerID: description: |- - ProviderID is the identification ID of the machine provided by the provider. + 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 @@ -741,12 +741,12 @@ spec: be interfacing with cluster-api as generic provider. type: string providerSpec: - description: ProviderSpec details Provider-specific configuration + description: providerSpec details Provider-specific configuration to use during node creation. properties: value: description: |- - Value is an inlined, serialized representation of the resource + 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. @@ -817,7 +817,7 @@ spec: properties: conditions: description: |- - Conditions represents the observations of the ControlPlaneMachineSet's current state. + conditions represents the observations of the ControlPlaneMachineSet's current state. Known .status.conditions.type are: Available, Degraded and Progressing. items: description: Condition contains details for one aspect of the current @@ -879,14 +879,14 @@ spec: x-kubernetes-list-type: map observedGeneration: description: |- - ObservedGeneration is the most recent generation observed for this + 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. format: int64 type: integer readyReplicas: description: |- - ReadyReplicas is the number of Control Plane Machines created by the + 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. @@ -894,7 +894,7 @@ spec: type: integer replicas: description: |- - Replicas is the number of Control Plane Machines created by the + 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. @@ -902,7 +902,7 @@ spec: type: integer unavailableReplicas: description: |- - UnavailableReplicas is the number of Control Plane Machines that are + 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. @@ -910,7 +910,7 @@ spec: type: integer updatedReplicas: description: |- - UpdatedReplicas is the number of non-terminated Control Plane Machines + 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. diff --git a/payload-manifests/crds/0000_10_control-plane-machine-set_01_controlplanemachinesets-DevPreviewNoUpgrade.crd.yaml b/payload-manifests/crds/0000_10_control-plane-machine-set_01_controlplanemachinesets-DevPreviewNoUpgrade.crd.yaml index 1fb11eeb194..78ff1eca481 100644 --- a/payload-manifests/crds/0000_10_control-plane-machine-set_01_controlplanemachinesets-DevPreviewNoUpgrade.crd.yaml +++ b/payload-manifests/crds/0000_10_control-plane-machine-set_01_controlplanemachinesets-DevPreviewNoUpgrade.crd.yaml @@ -98,7 +98,7 @@ spec: replicas: default: 3 description: |- - Replicas defines how many Control Plane Machines should be + replicas defines how many Control Plane Machines should be created by this ControlPlaneMachineSet. This field is immutable and cannot be changed after cluster installation. @@ -168,7 +168,7 @@ spec: state: default: Inactive description: |- - State defines whether the ControlPlaneMachineSet is Active or Inactive. + 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 @@ -186,13 +186,13 @@ spec: default: type: RollingUpdate description: |- - Strategy defines how the ControlPlaneMachineSet will update + strategy defines how the ControlPlaneMachineSet will update Machines when it detects a change to the ProviderSpec. properties: type: default: RollingUpdate description: |- - Type defines the type of update strategy that should be + 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". @@ -203,12 +203,12 @@ spec: type: object template: description: |- - Template describes the Control Plane Machines that will be created + template describes the Control Plane Machines that will be created by this ControlPlaneMachineSet. properties: machineType: description: |- - MachineType determines the type of Machines that should be managed by the ControlPlaneMachineSet. + machineType determines the type of Machines that should be managed by the ControlPlaneMachineSet. Currently, the only valid value is machines_v1beta1_machine_openshift_io. enum: - machines_v1beta1_machine_openshift_io @@ -220,14 +220,14 @@ spec: properties: failureDomains: description: |- - FailureDomains is the list of failure domains (sometimes called + 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. properties: aws: - description: AWS configures failure domain information + description: aws configures failure domain information for the AWS platform. items: description: AWSFailureDomain configures failure domain @@ -235,32 +235,32 @@ spec: minProperties: 1 properties: placement: - description: Placement configures the placement + description: placement configures the placement information for this instance. properties: availabilityZone: - description: AvailabilityZone is the availability + description: availabilityZone is the availability zone of the instance. type: string required: - availabilityZone type: object subnet: - description: Subnet is a reference to the subnet + description: subnet is a reference to the subnet to use for this instance. properties: arn: - description: ARN of resource. + description: arn of resource. type: string filters: - description: Filters is a set of filters used + description: filters is a set of filters used to identify a resource. items: description: AWSResourceFilter is a filter used to identify an AWS resource properties: name: - description: Name of the filter. Filter + description: name of the filter. Filter names are case-sensitive. type: string values: @@ -276,10 +276,10 @@ spec: type: array x-kubernetes-list-type: atomic id: - description: ID of resource. + description: id of resource. type: string type: - description: Type determines how the reference + description: type determines how the reference will fetch the AWS resource. enum: - ID @@ -306,7 +306,7 @@ spec: type: array x-kubernetes-list-type: atomic azure: - description: Azure configures failure domain information + description: azure configures failure domain information for the Azure platform. items: description: AzureFailureDomain configures failure domain @@ -330,14 +330,14 @@ spec: type: array x-kubernetes-list-type: atomic gcp: - description: GCP configures failure domain information + description: gcp configures failure domain information for the GCP platform. items: description: GCPFailureDomain configures failure domain information for the GCP platform properties: zone: - description: Zone is the zone in which the GCP machine + description: zone is the zone in which the GCP machine provider will create the VM. type: string required: @@ -368,7 +368,7 @@ spec: - name x-kubernetes-list-type: map openstack: - description: OpenStack configures failure domain information + description: openstack configures failure domain information for the OpenStack platform. items: description: OpenStackFailureDomain configures failure @@ -427,7 +427,7 @@ spec: x-kubernetes-list-type: atomic platform: description: |- - Platform identifies the platform for which the FailureDomain represents. + platform identifies the platform for which the FailureDomain represents. Currently supported values are AWS, Azure, GCP, OpenStack, VSphere and Nutanix. enum: - "" @@ -507,7 +507,7 @@ spec: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + 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 @@ -543,7 +543,7 @@ spec: type: object spec: description: |- - Spec contains the desired configuration of the Control Plane Machines. + 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 @@ -552,12 +552,12 @@ spec: properties: lifecycleHooks: description: |- - LifecycleHooks allow users to pause operations on the machine at + lifecycleHooks allow users to pause operations on the machine at certain predefined points within the machine lifecycle. properties: preDrain: description: |- - PreDrain hooks prevent the machine from being drained. + preDrain hooks prevent the machine from being drained. This also blocks further lifecycle events, such as termination. items: description: LifecycleHook represents a single instance @@ -565,7 +565,7 @@ spec: properties: name: description: |- - Name defines a unique name for the lifcycle hook. + 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. @@ -575,7 +575,7 @@ spec: type: string owner: description: |- - Owner defines the owner of the lifecycle hook. + 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) @@ -593,7 +593,7 @@ spec: x-kubernetes-list-type: map preTerminate: description: |- - PreTerminate hooks prevent the machine from being terminated. + preTerminate hooks prevent the machine from being terminated. PreTerminate hooks be actioned after the Machine has been drained. items: description: LifecycleHook represents a single instance @@ -601,7 +601,7 @@ spec: properties: name: description: |- - Name defines a unique name for the lifcycle hook. + 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. @@ -611,7 +611,7 @@ spec: type: string owner: description: |- - Owner defines the owner of the lifecycle hook. + 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) @@ -638,14 +638,14 @@ spec: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + 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 generateName: description: |- - GenerateName is an optional prefix, used by the server, to generate a unique + 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. @@ -672,7 +672,7 @@ spec: type: object name: description: |- - Name must be unique within a namespace. Is required when creating resources, although + 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. @@ -681,7 +681,7 @@ spec: type: string namespace: description: |- - Namespace defines the space within each name must be unique. An empty namespace is + 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. @@ -749,7 +749,7 @@ spec: type: object providerID: description: |- - ProviderID is the identification ID of the machine provided by the provider. + 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 @@ -761,12 +761,12 @@ spec: be interfacing with cluster-api as generic provider. type: string providerSpec: - description: ProviderSpec details Provider-specific configuration + description: providerSpec details Provider-specific configuration to use during node creation. properties: value: description: |- - Value is an inlined, serialized representation of the resource + 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. @@ -837,7 +837,7 @@ spec: properties: conditions: description: |- - Conditions represents the observations of the ControlPlaneMachineSet's current state. + conditions represents the observations of the ControlPlaneMachineSet's current state. Known .status.conditions.type are: Available, Degraded and Progressing. items: description: Condition contains details for one aspect of the current @@ -899,14 +899,14 @@ spec: x-kubernetes-list-type: map observedGeneration: description: |- - ObservedGeneration is the most recent generation observed for this + 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. format: int64 type: integer readyReplicas: description: |- - ReadyReplicas is the number of Control Plane Machines created by the + 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. @@ -914,7 +914,7 @@ spec: type: integer replicas: description: |- - Replicas is the number of Control Plane Machines created by the + 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. @@ -922,7 +922,7 @@ spec: type: integer unavailableReplicas: description: |- - UnavailableReplicas is the number of Control Plane Machines that are + 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. @@ -930,7 +930,7 @@ spec: type: integer updatedReplicas: description: |- - UpdatedReplicas is the number of non-terminated Control Plane Machines + 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. diff --git a/payload-manifests/crds/0000_10_control-plane-machine-set_01_controlplanemachinesets-TechPreviewNoUpgrade.crd.yaml b/payload-manifests/crds/0000_10_control-plane-machine-set_01_controlplanemachinesets-TechPreviewNoUpgrade.crd.yaml index f3f3b6717b9..a72970ca0cd 100644 --- a/payload-manifests/crds/0000_10_control-plane-machine-set_01_controlplanemachinesets-TechPreviewNoUpgrade.crd.yaml +++ b/payload-manifests/crds/0000_10_control-plane-machine-set_01_controlplanemachinesets-TechPreviewNoUpgrade.crd.yaml @@ -98,7 +98,7 @@ spec: replicas: default: 3 description: |- - Replicas defines how many Control Plane Machines should be + replicas defines how many Control Plane Machines should be created by this ControlPlaneMachineSet. This field is immutable and cannot be changed after cluster installation. @@ -168,7 +168,7 @@ spec: state: default: Inactive description: |- - State defines whether the ControlPlaneMachineSet is Active or Inactive. + 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 @@ -186,13 +186,13 @@ spec: default: type: RollingUpdate description: |- - Strategy defines how the ControlPlaneMachineSet will update + strategy defines how the ControlPlaneMachineSet will update Machines when it detects a change to the ProviderSpec. properties: type: default: RollingUpdate description: |- - Type defines the type of update strategy that should be + 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". @@ -203,12 +203,12 @@ spec: type: object template: description: |- - Template describes the Control Plane Machines that will be created + template describes the Control Plane Machines that will be created by this ControlPlaneMachineSet. properties: machineType: description: |- - MachineType determines the type of Machines that should be managed by the ControlPlaneMachineSet. + machineType determines the type of Machines that should be managed by the ControlPlaneMachineSet. Currently, the only valid value is machines_v1beta1_machine_openshift_io. enum: - machines_v1beta1_machine_openshift_io @@ -220,14 +220,14 @@ spec: properties: failureDomains: description: |- - FailureDomains is the list of failure domains (sometimes called + 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. properties: aws: - description: AWS configures failure domain information + description: aws configures failure domain information for the AWS platform. items: description: AWSFailureDomain configures failure domain @@ -235,32 +235,32 @@ spec: minProperties: 1 properties: placement: - description: Placement configures the placement + description: placement configures the placement information for this instance. properties: availabilityZone: - description: AvailabilityZone is the availability + description: availabilityZone is the availability zone of the instance. type: string required: - availabilityZone type: object subnet: - description: Subnet is a reference to the subnet + description: subnet is a reference to the subnet to use for this instance. properties: arn: - description: ARN of resource. + description: arn of resource. type: string filters: - description: Filters is a set of filters used + description: filters is a set of filters used to identify a resource. items: description: AWSResourceFilter is a filter used to identify an AWS resource properties: name: - description: Name of the filter. Filter + description: name of the filter. Filter names are case-sensitive. type: string values: @@ -276,10 +276,10 @@ spec: type: array x-kubernetes-list-type: atomic id: - description: ID of resource. + description: id of resource. type: string type: - description: Type determines how the reference + description: type determines how the reference will fetch the AWS resource. enum: - ID @@ -306,7 +306,7 @@ spec: type: array x-kubernetes-list-type: atomic azure: - description: Azure configures failure domain information + description: azure configures failure domain information for the Azure platform. items: description: AzureFailureDomain configures failure domain @@ -330,14 +330,14 @@ spec: type: array x-kubernetes-list-type: atomic gcp: - description: GCP configures failure domain information + description: gcp configures failure domain information for the GCP platform. items: description: GCPFailureDomain configures failure domain information for the GCP platform properties: zone: - description: Zone is the zone in which the GCP machine + description: zone is the zone in which the GCP machine provider will create the VM. type: string required: @@ -368,7 +368,7 @@ spec: - name x-kubernetes-list-type: map openstack: - description: OpenStack configures failure domain information + description: openstack configures failure domain information for the OpenStack platform. items: description: OpenStackFailureDomain configures failure @@ -427,7 +427,7 @@ spec: x-kubernetes-list-type: atomic platform: description: |- - Platform identifies the platform for which the FailureDomain represents. + platform identifies the platform for which the FailureDomain represents. Currently supported values are AWS, Azure, GCP, OpenStack, VSphere and Nutanix. enum: - "" @@ -507,7 +507,7 @@ spec: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + 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 @@ -543,7 +543,7 @@ spec: type: object spec: description: |- - Spec contains the desired configuration of the Control Plane Machines. + 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 @@ -552,12 +552,12 @@ spec: properties: lifecycleHooks: description: |- - LifecycleHooks allow users to pause operations on the machine at + lifecycleHooks allow users to pause operations on the machine at certain predefined points within the machine lifecycle. properties: preDrain: description: |- - PreDrain hooks prevent the machine from being drained. + preDrain hooks prevent the machine from being drained. This also blocks further lifecycle events, such as termination. items: description: LifecycleHook represents a single instance @@ -565,7 +565,7 @@ spec: properties: name: description: |- - Name defines a unique name for the lifcycle hook. + 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. @@ -575,7 +575,7 @@ spec: type: string owner: description: |- - Owner defines the owner of the lifecycle hook. + 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) @@ -593,7 +593,7 @@ spec: x-kubernetes-list-type: map preTerminate: description: |- - PreTerminate hooks prevent the machine from being terminated. + preTerminate hooks prevent the machine from being terminated. PreTerminate hooks be actioned after the Machine has been drained. items: description: LifecycleHook represents a single instance @@ -601,7 +601,7 @@ spec: properties: name: description: |- - Name defines a unique name for the lifcycle hook. + 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. @@ -611,7 +611,7 @@ spec: type: string owner: description: |- - Owner defines the owner of the lifecycle hook. + 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) @@ -638,14 +638,14 @@ spec: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + 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 generateName: description: |- - GenerateName is an optional prefix, used by the server, to generate a unique + 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. @@ -672,7 +672,7 @@ spec: type: object name: description: |- - Name must be unique within a namespace. Is required when creating resources, although + 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. @@ -681,7 +681,7 @@ spec: type: string namespace: description: |- - Namespace defines the space within each name must be unique. An empty namespace is + 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. @@ -749,7 +749,7 @@ spec: type: object providerID: description: |- - ProviderID is the identification ID of the machine provided by the provider. + 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 @@ -761,12 +761,12 @@ spec: be interfacing with cluster-api as generic provider. type: string providerSpec: - description: ProviderSpec details Provider-specific configuration + description: providerSpec details Provider-specific configuration to use during node creation. properties: value: description: |- - Value is an inlined, serialized representation of the resource + 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. @@ -837,7 +837,7 @@ spec: properties: conditions: description: |- - Conditions represents the observations of the ControlPlaneMachineSet's current state. + conditions represents the observations of the ControlPlaneMachineSet's current state. Known .status.conditions.type are: Available, Degraded and Progressing. items: description: Condition contains details for one aspect of the current @@ -899,14 +899,14 @@ spec: x-kubernetes-list-type: map observedGeneration: description: |- - ObservedGeneration is the most recent generation observed for this + 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. format: int64 type: integer readyReplicas: description: |- - ReadyReplicas is the number of Control Plane Machines created by the + 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. @@ -914,7 +914,7 @@ spec: type: integer replicas: description: |- - Replicas is the number of Control Plane Machines created by the + 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. @@ -922,7 +922,7 @@ spec: type: integer unavailableReplicas: description: |- - UnavailableReplicas is the number of Control Plane Machines that are + 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. @@ -930,7 +930,7 @@ spec: type: integer updatedReplicas: description: |- - UpdatedReplicas is the number of non-terminated Control Plane Machines + 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. diff --git a/payload-manifests/crds/0000_10_etcd_01_etcdbackups-CustomNoUpgrade.crd.yaml b/payload-manifests/crds/0000_10_etcd_01_etcdbackups-CustomNoUpgrade.crd.yaml index cc2e015c731..49bba6f6cb3 100644 --- a/payload-manifests/crds/0000_10_etcd_01_etcdbackups-CustomNoUpgrade.crd.yaml +++ b/payload-manifests/crds/0000_10_etcd_01_etcdbackups-CustomNoUpgrade.crd.yaml @@ -47,7 +47,7 @@ spec: properties: pvcName: description: |- - PVCName specifies the name of the PersistentVolumeClaim (PVC) which binds a PersistentVolume where the + 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. diff --git a/payload-manifests/crds/0000_10_etcd_01_etcdbackups-DevPreviewNoUpgrade.crd.yaml b/payload-manifests/crds/0000_10_etcd_01_etcdbackups-DevPreviewNoUpgrade.crd.yaml index 68df34081b9..d015b811ce5 100644 --- a/payload-manifests/crds/0000_10_etcd_01_etcdbackups-DevPreviewNoUpgrade.crd.yaml +++ b/payload-manifests/crds/0000_10_etcd_01_etcdbackups-DevPreviewNoUpgrade.crd.yaml @@ -47,7 +47,7 @@ spec: properties: pvcName: description: |- - PVCName specifies the name of the PersistentVolumeClaim (PVC) which binds a PersistentVolume where the + 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. diff --git a/payload-manifests/crds/0000_10_etcd_01_etcdbackups-TechPreviewNoUpgrade.crd.yaml b/payload-manifests/crds/0000_10_etcd_01_etcdbackups-TechPreviewNoUpgrade.crd.yaml index 0bb78ad6d88..9d56894fdbb 100644 --- a/payload-manifests/crds/0000_10_etcd_01_etcdbackups-TechPreviewNoUpgrade.crd.yaml +++ b/payload-manifests/crds/0000_10_etcd_01_etcdbackups-TechPreviewNoUpgrade.crd.yaml @@ -47,7 +47,7 @@ spec: properties: pvcName: description: |- - PVCName specifies the name of the PersistentVolumeClaim (PVC) which binds a PersistentVolume where the + 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. diff --git a/payload-manifests/crds/0000_10_openshift-controller-manager_01_builds.crd.yaml b/payload-manifests/crds/0000_10_openshift-controller-manager_01_builds.crd.yaml index 34ca783627a..eeebfbbeb2d 100644 --- a/payload-manifests/crds/0000_10_openshift-controller-manager_01_builds.crd.yaml +++ b/payload-manifests/crds/0000_10_openshift-controller-manager_01_builds.crd.yaml @@ -46,12 +46,12 @@ spec: metadata: type: object spec: - description: Spec holds user-settable values for the build controller + description: spec holds user-settable values for the build controller configuration properties: additionalTrustedCA: description: |- - AdditionalTrustedCA is a reference to a ConfigMap containing additional CAs that + 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. @@ -66,11 +66,11 @@ spec: - name type: object buildDefaults: - description: BuildDefaults controls the default information for Builds + description: buildDefaults controls the default information for Builds properties: defaultProxy: description: |- - DefaultProxy contains the default proxy settings for all build operations, including image pull/push + defaultProxy contains the default proxy settings for all build operations, including image pull/push and source download. Values can be overrode by setting the `HTTP_PROXY`, `HTTPS_PROXY`, and `NO_PROXY` environment variables @@ -132,7 +132,7 @@ spec: type: object env: description: |- - Env is a set of default environment variables that will be applied to the + 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 items: description: EnvVar represents an environment variable present @@ -254,7 +254,7 @@ spec: type: array gitProxy: description: |- - GitProxy contains the proxy settings for git operations only. If set, this will override + 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. Values that are not set here will be inherited from DefaultProxy. @@ -315,22 +315,22 @@ spec: type: object imageLabels: description: |- - ImageLabels is a list of docker labels that are applied to the resulting image. + 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. items: properties: name: - description: Name defines the name of the label. It must + description: name defines the name of the label. It must have non-zero length. type: string value: - description: Value defines the literal value of the label. + description: value defines the literal value of the label. type: string type: object type: array resources: - description: Resources defines resource requirements to execute + description: resources defines resource requirements to execute the build. properties: claims: @@ -391,7 +391,7 @@ spec: type: object type: object buildOverrides: - description: BuildOverrides controls override settings for builds + description: buildOverrides controls override settings for builds properties: forcePull: description: |- @@ -402,24 +402,24 @@ spec: type: boolean imageLabels: description: |- - ImageLabels is a list of docker labels that are applied to the resulting image. + 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. items: properties: name: - description: Name defines the name of the label. It must + description: name defines the name of the label. It must have non-zero length. type: string value: - description: Value defines the literal value of the label. + description: value defines the literal value of the label. type: string type: object type: array nodeSelector: additionalProperties: type: string - description: NodeSelector is a selector which must be true for + description: nodeSelector is a selector which must be true for the build pod to fit on a node type: object tolerations: diff --git a/payload-manifests/crds/0000_50_authentication_01_authentications.crd.yaml b/payload-manifests/crds/0000_50_authentication_01_authentications.crd.yaml index 3fab2ff1f5c..029c91ac0fb 100644 --- a/payload-manifests/crds/0000_50_authentication_01_authentications.crd.yaml +++ b/payload-manifests/crds/0000_50_authentication_01_authentications.crd.yaml @@ -185,11 +185,11 @@ spec: - message: must only increase rule: self >= oldSelf oauthAPIServer: - description: OAuthAPIServer holds status specific only to oauth-apiserver + description: oauthAPIServer holds status specific only to oauth-apiserver properties: latestAvailableRevision: description: |- - LatestAvailableRevision is the latest revision used as suffix of revisioned + latestAvailableRevision is the latest revision used as suffix of revisioned secrets like encryption-config. A new revision causes a new deployment of pods. format: int32 minimum: 0 diff --git a/payload-manifests/crds/0000_50_csi-driver_01_clustercsidrivers.crd.yaml b/payload-manifests/crds/0000_50_csi-driver_01_clustercsidrivers.crd.yaml index 9a65a695acd..1db446757eb 100644 --- a/payload-manifests/crds/0000_50_csi-driver_01_clustercsidrivers.crd.yaml +++ b/payload-manifests/crds/0000_50_csi-driver_01_clustercsidrivers.crd.yaml @@ -253,7 +253,7 @@ spec: - encryptionKeyCRN type: object vSphere: - description: vsphere is used to configure the vsphere CSI driver. + description: vSphere is used to configure the vsphere CSI driver. properties: globalMaxSnapshotsPerBlockVolume: description: |- @@ -348,7 +348,7 @@ spec: type: string storageClassState: description: |- - StorageClassState determines if CSI operator should create and manage storage classes. + 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 diff --git a/payload-manifests/crds/0000_50_storage_01_storages.crd.yaml b/payload-manifests/crds/0000_50_storage_01_storages.crd.yaml index e0f84188143..2432d6c8bdc 100644 --- a/payload-manifests/crds/0000_50_storage_01_storages.crd.yaml +++ b/payload-manifests/crds/0000_50_storage_01_storages.crd.yaml @@ -98,7 +98,7 @@ spec: x-kubernetes-preserve-unknown-fields: true vsphereStorageDriver: description: |- - VSphereStorageDriver indicates the storage driver to use on VSphere clusters. + 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. diff --git a/payload-manifests/crds/0000_80_machine-config_01_containerruntimeconfigs.crd.yaml b/payload-manifests/crds/0000_80_machine-config_01_containerruntimeconfigs.crd.yaml index bd5297b1e60..71168270197 100644 --- a/payload-manifests/crds/0000_80_machine-config_01_containerruntimeconfigs.crd.yaml +++ b/payload-manifests/crds/0000_80_machine-config_01_containerruntimeconfigs.crd.yaml @@ -88,7 +88,7 @@ spec: type: object machineConfigPoolSelector: description: |- - MachineConfigPoolSelector selects which pools the ContainerRuntimeConfig shoud apply to. + machineConfigPoolSelector selects which pools the ContainerRuntimeConfig shoud apply to. A nil selector will result in no pools being selected. properties: matchExpressions: diff --git a/payload-manifests/crds/0000_80_machine-config_01_controllerconfigs-CustomNoUpgrade.crd.yaml b/payload-manifests/crds/0000_80_machine-config_01_controllerconfigs-CustomNoUpgrade.crd.yaml index 3b0f4fef8fc..4edf77e1e8a 100644 --- a/payload-manifests/crds/0000_80_machine-config_01_controllerconfigs-CustomNoUpgrade.crd.yaml +++ b/payload-manifests/crds/0000_80_machine-config_01_controllerconfigs-CustomNoUpgrade.crd.yaml @@ -56,11 +56,11 @@ spec: nullable: true type: string baseOSContainerImage: - description: BaseOSContainerImage is the new-format container image + description: baseOSContainerImage is the new-format container image for operating system updates. type: string baseOSExtensionsContainerImage: - description: BaseOSExtensionsContainerImage is the matching extensions + description: baseOSExtensionsContainerImage is the matching extensions container for the new-format container type: string cloudProviderCAData: @@ -337,7 +337,7 @@ spec: All the clients are expected to use the generated ConfigMap only. properties: key: - description: Key allows pointing to a specific key/value + description: key allows pointing to a specific key/value inside of the configmap. This is useful for logical file references. type: string @@ -350,11 +350,11 @@ spec: infrastructure provider. properties: alibabaCloud: - description: AlibabaCloud contains settings specific to + description: alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. type: object aws: - description: AWS contains settings specific to the Amazon + description: aws contains settings specific to the Amazon Web Services infrastructure provider. properties: serviceEndpoints: @@ -386,11 +386,11 @@ spec: x-kubernetes-list-type: atomic type: object azure: - description: Azure contains settings specific to the Azure + description: azure contains settings specific to the Azure infrastructure provider. type: object baremetal: - description: BareMetal contains settings specific to the + description: baremetal contains settings specific to the BareMetal platform. properties: apiServerInternalIPs: @@ -477,7 +477,7 @@ spec: - message: ingressIPs list is required once set rule: '!has(oldSelf.ingressIPs) || has(self.ingressIPs)' equinixMetal: - description: EquinixMetal contains settings specific to + description: equinixMetal contains settings specific to the Equinix Metal infrastructure provider. type: object external: @@ -488,7 +488,7 @@ spec: platformName: default: Unknown description: |- - PlatformName holds the arbitrary string representing the infrastructure provider name, expected to be set at the installation time. + 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 x-kubernetes-validations: @@ -496,19 +496,19 @@ spec: rule: oldSelf == 'Unknown' || self == oldSelf type: object gcp: - description: GCP contains settings specific to the Google + description: gcp contains settings specific to the Google Cloud Platform infrastructure provider. type: object ibmcloud: - description: IBMCloud contains settings specific to the + description: ibmcloud contains settings specific to the IBMCloud infrastructure provider. type: object kubevirt: - description: Kubevirt contains settings specific to the + description: kubevirt contains settings specific to the kubevirt infrastructure provider. type: object nutanix: - description: Nutanix contains settings specific to the + description: nutanix contains settings specific to the Nutanix infrastructure provider. properties: failureDomains: @@ -703,7 +703,7 @@ spec: - prismElements type: object openstack: - description: OpenStack contains settings specific to the + description: openstack contains settings specific to the OpenStack infrastructure provider. properties: apiServerInternalIPs: @@ -790,11 +790,11 @@ spec: - message: ingressIPs list is required once set rule: '!has(oldSelf.ingressIPs) || has(self.ingressIPs)' ovirt: - description: Ovirt contains settings specific to the oVirt + description: ovirt contains settings specific to the oVirt infrastructure provider. type: object powervs: - description: PowerVS contains settings specific to the + description: powervs contains settings specific to the IBM Power Systems Virtual Servers infrastructure provider. properties: serviceEndpoints: @@ -876,7 +876,7 @@ spec: - External type: string vsphere: - description: VSphere contains settings specific to the + description: vsphere contains settings specific to the VSphere infrastructure provider. properties: apiServerInternalIPs: @@ -958,7 +958,7 @@ spec: minLength: 1 type: string topology: - description: Topology describes a given failure + description: topology describes a given failure domain using vSphere constructs properties: computeCluster: @@ -1410,7 +1410,7 @@ spec: infrastructure provider. properties: alibabaCloud: - description: AlibabaCloud contains settings specific to + description: alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. properties: region: @@ -1454,7 +1454,7 @@ spec: - region type: object aws: - description: AWS contains settings specific to the Amazon + description: aws contains settings specific to the Amazon Web Services infrastructure provider. properties: cloudLoadBalancerConfig: @@ -1599,7 +1599,7 @@ spec: x-kubernetes-list-type: atomic serviceEndpoints: description: |- - ServiceEndpoints list contains custom endpoints which will override default + serviceEndpoints list contains custom endpoints which will override default service endpoint of AWS Services. There must be only one ServiceEndpoint for a service. items: @@ -1626,7 +1626,7 @@ spec: x-kubernetes-list-type: atomic type: object azure: - description: Azure contains settings specific to the Azure + description: azure contains settings specific to the Azure infrastructure provider. properties: armEndpoint: @@ -1702,7 +1702,7 @@ spec: rule: '!has(oldSelf.resourceTags) && !has(self.resourceTags) || has(oldSelf.resourceTags) && has(self.resourceTags)' baremetal: - description: BareMetal contains settings specific to the + description: baremetal contains settings specific to the BareMetal platform. properties: apiServerInternalIP: @@ -1812,7 +1812,7 @@ spec: type: string type: object equinixMetal: - description: EquinixMetal contains settings specific to + description: equinixMetal contains settings specific to the Equinix Metal infrastructure provider. properties: apiServerInternalIP: @@ -1829,7 +1829,7 @@ spec: type: string type: object external: - description: External contains settings specific to the + description: external contains settings specific to the generic External infrastructure provider. properties: cloudControllerManager: @@ -1869,7 +1869,7 @@ spec: removed once set rule: has(self.cloudControllerManager) == has(oldSelf.cloudControllerManager) gcp: - description: GCP contains settings specific to the Google + description: gcp contains settings specific to the Google Cloud Platform infrastructure provider. properties: cloudLoadBalancerConfig: @@ -2097,29 +2097,29 @@ spec: rule: '!has(oldSelf.resourceTags) && !has(self.resourceTags) || has(oldSelf.resourceTags) && has(self.resourceTags)' ibmcloud: - description: IBMCloud contains settings specific to the + description: ibmcloud contains settings specific to the IBMCloud infrastructure provider. properties: cisInstanceCRN: description: |- - CISInstanceCRN is the CRN of the Cloud Internet Services instance managing + 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 + 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 + description: location is where the cluster has been deployed type: string providerType: - description: ProviderType indicates the type of cluster + description: providerType indicates the type of cluster that was created type: string resourceGroupName: - description: ResourceGroupName is the Resource Group + description: resourceGroupName is the Resource Group for new IBMCloud resources created for the cluster. type: string serviceEndpoints: @@ -2174,7 +2174,7 @@ spec: x-kubernetes-list-type: map type: object kubevirt: - description: Kubevirt contains settings specific to the + description: kubevirt contains settings specific to the kubevirt infrastructure provider. properties: apiServerInternalIP: @@ -2191,7 +2191,7 @@ spec: type: string type: object nutanix: - description: Nutanix contains settings specific to the + description: nutanix contains settings specific to the Nutanix infrastructure provider. properties: apiServerInternalIP: @@ -2275,7 +2275,7 @@ spec: type: object type: object openstack: - description: OpenStack contains settings specific to the + description: openstack contains settings specific to the OpenStack infrastructure provider. properties: apiServerInternalIP: @@ -2390,7 +2390,7 @@ spec: type: string type: object ovirt: - description: Ovirt contains settings specific to the oVirt + description: ovirt contains settings specific to the oVirt infrastructure provider. properties: apiServerInternalIP: @@ -2479,17 +2479,17 @@ spec: type: string type: object powervs: - description: PowerVS contains settings specific to the + description: powervs contains settings specific to the Power Systems Virtual Servers infrastructure provider. properties: cisInstanceCRN: description: |- - CISInstanceCRN is the CRN of the Cloud Internet Services instance managing + 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 + dnsInstanceCRN is the CRN of the DNS Services instance managing the DNS zone for the cluster's base domain type: string region: @@ -2599,7 +2599,7 @@ spec: - External type: string vsphere: - description: VSphere contains settings specific to the + description: vsphere contains settings specific to the VSphere infrastructure provider. properties: apiServerInternalIP: @@ -2731,15 +2731,15 @@ spec: format: byte type: string network: - description: Network contains additional network related information + description: network contains additional network related information nullable: true properties: mtuMigration: - description: MTUMigration contains the MTU migration configuration. + description: mtuMigration contains the MTU migration configuration. nullable: true properties: machine: - description: Machine contains MTU migration configuration + description: machine contains MTU migration configuration for the machine's uplink. properties: from: @@ -2754,7 +2754,7 @@ spec: type: integer type: object network: - description: Network contains MTU migration configuration + description: network contains MTU migration configuration for the default network. properties: from: @@ -2781,7 +2781,7 @@ spec: regeneration if this changes. type: string osImageURL: - description: OSImageURL is the old-format container image that contains + description: osImageURL is the old-format container image that contains the OS update payload. type: string platform: diff --git a/payload-manifests/crds/0000_80_machine-config_01_controllerconfigs-Default.crd.yaml b/payload-manifests/crds/0000_80_machine-config_01_controllerconfigs-Default.crd.yaml index 56fc8e2128e..c7c6597981d 100644 --- a/payload-manifests/crds/0000_80_machine-config_01_controllerconfigs-Default.crd.yaml +++ b/payload-manifests/crds/0000_80_machine-config_01_controllerconfigs-Default.crd.yaml @@ -56,11 +56,11 @@ spec: nullable: true type: string baseOSContainerImage: - description: BaseOSContainerImage is the new-format container image + description: baseOSContainerImage is the new-format container image for operating system updates. type: string baseOSExtensionsContainerImage: - description: BaseOSExtensionsContainerImage is the matching extensions + description: baseOSExtensionsContainerImage is the matching extensions container for the new-format container type: string cloudProviderCAData: @@ -337,7 +337,7 @@ spec: All the clients are expected to use the generated ConfigMap only. properties: key: - description: Key allows pointing to a specific key/value + description: key allows pointing to a specific key/value inside of the configmap. This is useful for logical file references. type: string @@ -350,11 +350,11 @@ spec: infrastructure provider. properties: alibabaCloud: - description: AlibabaCloud contains settings specific to + description: alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. type: object aws: - description: AWS contains settings specific to the Amazon + description: aws contains settings specific to the Amazon Web Services infrastructure provider. properties: serviceEndpoints: @@ -386,11 +386,11 @@ spec: x-kubernetes-list-type: atomic type: object azure: - description: Azure contains settings specific to the Azure + description: azure contains settings specific to the Azure infrastructure provider. type: object baremetal: - description: BareMetal contains settings specific to the + description: baremetal contains settings specific to the BareMetal platform. properties: apiServerInternalIPs: @@ -477,7 +477,7 @@ spec: - message: ingressIPs list is required once set rule: '!has(oldSelf.ingressIPs) || has(self.ingressIPs)' equinixMetal: - description: EquinixMetal contains settings specific to + description: equinixMetal contains settings specific to the Equinix Metal infrastructure provider. type: object external: @@ -488,7 +488,7 @@ spec: platformName: default: Unknown description: |- - PlatformName holds the arbitrary string representing the infrastructure provider name, expected to be set at the installation time. + 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 x-kubernetes-validations: @@ -496,19 +496,19 @@ spec: rule: oldSelf == 'Unknown' || self == oldSelf type: object gcp: - description: GCP contains settings specific to the Google + description: gcp contains settings specific to the Google Cloud Platform infrastructure provider. type: object ibmcloud: - description: IBMCloud contains settings specific to the + description: ibmcloud contains settings specific to the IBMCloud infrastructure provider. type: object kubevirt: - description: Kubevirt contains settings specific to the + description: kubevirt contains settings specific to the kubevirt infrastructure provider. type: object nutanix: - description: Nutanix contains settings specific to the + description: nutanix contains settings specific to the Nutanix infrastructure provider. properties: failureDomains: @@ -698,7 +698,7 @@ spec: - prismElements type: object openstack: - description: OpenStack contains settings specific to the + description: openstack contains settings specific to the OpenStack infrastructure provider. properties: apiServerInternalIPs: @@ -785,11 +785,11 @@ spec: - message: ingressIPs list is required once set rule: '!has(oldSelf.ingressIPs) || has(self.ingressIPs)' ovirt: - description: Ovirt contains settings specific to the oVirt + description: ovirt contains settings specific to the oVirt infrastructure provider. type: object powervs: - description: PowerVS contains settings specific to the + description: powervs contains settings specific to the IBM Power Systems Virtual Servers infrastructure provider. properties: serviceEndpoints: @@ -871,7 +871,7 @@ spec: - External type: string vsphere: - description: VSphere contains settings specific to the + description: vsphere contains settings specific to the VSphere infrastructure provider. properties: apiServerInternalIPs: @@ -953,7 +953,7 @@ spec: minLength: 1 type: string topology: - description: Topology describes a given failure + description: topology describes a given failure domain using vSphere constructs properties: computeCluster: @@ -1405,7 +1405,7 @@ spec: infrastructure provider. properties: alibabaCloud: - description: AlibabaCloud contains settings specific to + description: alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. properties: region: @@ -1449,7 +1449,7 @@ spec: - region type: object aws: - description: AWS contains settings specific to the Amazon + description: aws contains settings specific to the Amazon Web Services infrastructure provider. properties: region: @@ -1490,7 +1490,7 @@ spec: x-kubernetes-list-type: atomic serviceEndpoints: description: |- - ServiceEndpoints list contains custom endpoints which will override default + serviceEndpoints list contains custom endpoints which will override default service endpoint of AWS Services. There must be only one ServiceEndpoint for a service. items: @@ -1517,7 +1517,7 @@ spec: x-kubernetes-list-type: atomic type: object azure: - description: Azure contains settings specific to the Azure + description: azure contains settings specific to the Azure infrastructure provider. properties: armEndpoint: @@ -1593,7 +1593,7 @@ spec: rule: '!has(oldSelf.resourceTags) && !has(self.resourceTags) || has(oldSelf.resourceTags) && has(self.resourceTags)' baremetal: - description: BareMetal contains settings specific to the + description: baremetal contains settings specific to the BareMetal platform. properties: apiServerInternalIP: @@ -1703,7 +1703,7 @@ spec: type: string type: object equinixMetal: - description: EquinixMetal contains settings specific to + description: equinixMetal contains settings specific to the Equinix Metal infrastructure provider. properties: apiServerInternalIP: @@ -1720,7 +1720,7 @@ spec: type: string type: object external: - description: External contains settings specific to the + description: external contains settings specific to the generic External infrastructure provider. properties: cloudControllerManager: @@ -1760,7 +1760,7 @@ spec: removed once set rule: has(self.cloudControllerManager) == has(oldSelf.cloudControllerManager) gcp: - description: GCP contains settings specific to the Google + description: gcp contains settings specific to the Google Cloud Platform infrastructure provider. properties: projectID: @@ -1884,29 +1884,29 @@ spec: rule: '!has(oldSelf.resourceTags) && !has(self.resourceTags) || has(oldSelf.resourceTags) && has(self.resourceTags)' ibmcloud: - description: IBMCloud contains settings specific to the + description: ibmcloud contains settings specific to the IBMCloud infrastructure provider. properties: cisInstanceCRN: description: |- - CISInstanceCRN is the CRN of the Cloud Internet Services instance managing + 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 + 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 + description: location is where the cluster has been deployed type: string providerType: - description: ProviderType indicates the type of cluster + description: providerType indicates the type of cluster that was created type: string resourceGroupName: - description: ResourceGroupName is the Resource Group + description: resourceGroupName is the Resource Group for new IBMCloud resources created for the cluster. type: string serviceEndpoints: @@ -1961,7 +1961,7 @@ spec: x-kubernetes-list-type: map type: object kubevirt: - description: Kubevirt contains settings specific to the + description: kubevirt contains settings specific to the kubevirt infrastructure provider. properties: apiServerInternalIP: @@ -1978,7 +1978,7 @@ spec: type: string type: object nutanix: - description: Nutanix contains settings specific to the + description: nutanix contains settings specific to the Nutanix infrastructure provider. properties: apiServerInternalIP: @@ -2062,7 +2062,7 @@ spec: type: object type: object openstack: - description: OpenStack contains settings specific to the + description: openstack contains settings specific to the OpenStack infrastructure provider. properties: apiServerInternalIP: @@ -2177,7 +2177,7 @@ spec: type: string type: object ovirt: - description: Ovirt contains settings specific to the oVirt + description: ovirt contains settings specific to the oVirt infrastructure provider. properties: apiServerInternalIP: @@ -2266,17 +2266,17 @@ spec: type: string type: object powervs: - description: PowerVS contains settings specific to the + description: powervs contains settings specific to the Power Systems Virtual Servers infrastructure provider. properties: cisInstanceCRN: description: |- - CISInstanceCRN is the CRN of the Cloud Internet Services instance managing + 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 + dnsInstanceCRN is the CRN of the DNS Services instance managing the DNS zone for the cluster's base domain type: string region: @@ -2386,7 +2386,7 @@ spec: - External type: string vsphere: - description: VSphere contains settings specific to the + description: vsphere contains settings specific to the VSphere infrastructure provider. properties: apiServerInternalIP: @@ -2518,15 +2518,15 @@ spec: format: byte type: string network: - description: Network contains additional network related information + description: network contains additional network related information nullable: true properties: mtuMigration: - description: MTUMigration contains the MTU migration configuration. + description: mtuMigration contains the MTU migration configuration. nullable: true properties: machine: - description: Machine contains MTU migration configuration + description: machine contains MTU migration configuration for the machine's uplink. properties: from: @@ -2541,7 +2541,7 @@ spec: type: integer type: object network: - description: Network contains MTU migration configuration + description: network contains MTU migration configuration for the default network. properties: from: @@ -2568,7 +2568,7 @@ spec: regeneration if this changes. type: string osImageURL: - description: OSImageURL is the old-format container image that contains + description: osImageURL is the old-format container image that contains the OS update payload. type: string platform: diff --git a/payload-manifests/crds/0000_80_machine-config_01_controllerconfigs-DevPreviewNoUpgrade.crd.yaml b/payload-manifests/crds/0000_80_machine-config_01_controllerconfigs-DevPreviewNoUpgrade.crd.yaml index a4690058e36..6f66684e2db 100644 --- a/payload-manifests/crds/0000_80_machine-config_01_controllerconfigs-DevPreviewNoUpgrade.crd.yaml +++ b/payload-manifests/crds/0000_80_machine-config_01_controllerconfigs-DevPreviewNoUpgrade.crd.yaml @@ -56,11 +56,11 @@ spec: nullable: true type: string baseOSContainerImage: - description: BaseOSContainerImage is the new-format container image + description: baseOSContainerImage is the new-format container image for operating system updates. type: string baseOSExtensionsContainerImage: - description: BaseOSExtensionsContainerImage is the matching extensions + description: baseOSExtensionsContainerImage is the matching extensions container for the new-format container type: string cloudProviderCAData: @@ -337,7 +337,7 @@ spec: All the clients are expected to use the generated ConfigMap only. properties: key: - description: Key allows pointing to a specific key/value + description: key allows pointing to a specific key/value inside of the configmap. This is useful for logical file references. type: string @@ -350,11 +350,11 @@ spec: infrastructure provider. properties: alibabaCloud: - description: AlibabaCloud contains settings specific to + description: alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. type: object aws: - description: AWS contains settings specific to the Amazon + description: aws contains settings specific to the Amazon Web Services infrastructure provider. properties: serviceEndpoints: @@ -386,11 +386,11 @@ spec: x-kubernetes-list-type: atomic type: object azure: - description: Azure contains settings specific to the Azure + description: azure contains settings specific to the Azure infrastructure provider. type: object baremetal: - description: BareMetal contains settings specific to the + description: baremetal contains settings specific to the BareMetal platform. properties: apiServerInternalIPs: @@ -477,7 +477,7 @@ spec: - message: ingressIPs list is required once set rule: '!has(oldSelf.ingressIPs) || has(self.ingressIPs)' equinixMetal: - description: EquinixMetal contains settings specific to + description: equinixMetal contains settings specific to the Equinix Metal infrastructure provider. type: object external: @@ -488,7 +488,7 @@ spec: platformName: default: Unknown description: |- - PlatformName holds the arbitrary string representing the infrastructure provider name, expected to be set at the installation time. + 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 x-kubernetes-validations: @@ -496,19 +496,19 @@ spec: rule: oldSelf == 'Unknown' || self == oldSelf type: object gcp: - description: GCP contains settings specific to the Google + description: gcp contains settings specific to the Google Cloud Platform infrastructure provider. type: object ibmcloud: - description: IBMCloud contains settings specific to the + description: ibmcloud contains settings specific to the IBMCloud infrastructure provider. type: object kubevirt: - description: Kubevirt contains settings specific to the + description: kubevirt contains settings specific to the kubevirt infrastructure provider. type: object nutanix: - description: Nutanix contains settings specific to the + description: nutanix contains settings specific to the Nutanix infrastructure provider. properties: failureDomains: @@ -703,7 +703,7 @@ spec: - prismElements type: object openstack: - description: OpenStack contains settings specific to the + description: openstack contains settings specific to the OpenStack infrastructure provider. properties: apiServerInternalIPs: @@ -790,11 +790,11 @@ spec: - message: ingressIPs list is required once set rule: '!has(oldSelf.ingressIPs) || has(self.ingressIPs)' ovirt: - description: Ovirt contains settings specific to the oVirt + description: ovirt contains settings specific to the oVirt infrastructure provider. type: object powervs: - description: PowerVS contains settings specific to the + description: powervs contains settings specific to the IBM Power Systems Virtual Servers infrastructure provider. properties: serviceEndpoints: @@ -876,7 +876,7 @@ spec: - External type: string vsphere: - description: VSphere contains settings specific to the + description: vsphere contains settings specific to the VSphere infrastructure provider. properties: apiServerInternalIPs: @@ -958,7 +958,7 @@ spec: minLength: 1 type: string topology: - description: Topology describes a given failure + description: topology describes a given failure domain using vSphere constructs properties: computeCluster: @@ -1410,7 +1410,7 @@ spec: infrastructure provider. properties: alibabaCloud: - description: AlibabaCloud contains settings specific to + description: alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. properties: region: @@ -1454,7 +1454,7 @@ spec: - region type: object aws: - description: AWS contains settings specific to the Amazon + description: aws contains settings specific to the Amazon Web Services infrastructure provider. properties: cloudLoadBalancerConfig: @@ -1599,7 +1599,7 @@ spec: x-kubernetes-list-type: atomic serviceEndpoints: description: |- - ServiceEndpoints list contains custom endpoints which will override default + serviceEndpoints list contains custom endpoints which will override default service endpoint of AWS Services. There must be only one ServiceEndpoint for a service. items: @@ -1626,7 +1626,7 @@ spec: x-kubernetes-list-type: atomic type: object azure: - description: Azure contains settings specific to the Azure + description: azure contains settings specific to the Azure infrastructure provider. properties: armEndpoint: @@ -1702,7 +1702,7 @@ spec: rule: '!has(oldSelf.resourceTags) && !has(self.resourceTags) || has(oldSelf.resourceTags) && has(self.resourceTags)' baremetal: - description: BareMetal contains settings specific to the + description: baremetal contains settings specific to the BareMetal platform. properties: apiServerInternalIP: @@ -1812,7 +1812,7 @@ spec: type: string type: object equinixMetal: - description: EquinixMetal contains settings specific to + description: equinixMetal contains settings specific to the Equinix Metal infrastructure provider. properties: apiServerInternalIP: @@ -1829,7 +1829,7 @@ spec: type: string type: object external: - description: External contains settings specific to the + description: external contains settings specific to the generic External infrastructure provider. properties: cloudControllerManager: @@ -1869,7 +1869,7 @@ spec: removed once set rule: has(self.cloudControllerManager) == has(oldSelf.cloudControllerManager) gcp: - description: GCP contains settings specific to the Google + description: gcp contains settings specific to the Google Cloud Platform infrastructure provider. properties: cloudLoadBalancerConfig: @@ -2097,29 +2097,29 @@ spec: rule: '!has(oldSelf.resourceTags) && !has(self.resourceTags) || has(oldSelf.resourceTags) && has(self.resourceTags)' ibmcloud: - description: IBMCloud contains settings specific to the + description: ibmcloud contains settings specific to the IBMCloud infrastructure provider. properties: cisInstanceCRN: description: |- - CISInstanceCRN is the CRN of the Cloud Internet Services instance managing + 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 + 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 + description: location is where the cluster has been deployed type: string providerType: - description: ProviderType indicates the type of cluster + description: providerType indicates the type of cluster that was created type: string resourceGroupName: - description: ResourceGroupName is the Resource Group + description: resourceGroupName is the Resource Group for new IBMCloud resources created for the cluster. type: string serviceEndpoints: @@ -2174,7 +2174,7 @@ spec: x-kubernetes-list-type: map type: object kubevirt: - description: Kubevirt contains settings specific to the + description: kubevirt contains settings specific to the kubevirt infrastructure provider. properties: apiServerInternalIP: @@ -2191,7 +2191,7 @@ spec: type: string type: object nutanix: - description: Nutanix contains settings specific to the + description: nutanix contains settings specific to the Nutanix infrastructure provider. properties: apiServerInternalIP: @@ -2275,7 +2275,7 @@ spec: type: object type: object openstack: - description: OpenStack contains settings specific to the + description: openstack contains settings specific to the OpenStack infrastructure provider. properties: apiServerInternalIP: @@ -2390,7 +2390,7 @@ spec: type: string type: object ovirt: - description: Ovirt contains settings specific to the oVirt + description: ovirt contains settings specific to the oVirt infrastructure provider. properties: apiServerInternalIP: @@ -2479,17 +2479,17 @@ spec: type: string type: object powervs: - description: PowerVS contains settings specific to the + description: powervs contains settings specific to the Power Systems Virtual Servers infrastructure provider. properties: cisInstanceCRN: description: |- - CISInstanceCRN is the CRN of the Cloud Internet Services instance managing + 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 + dnsInstanceCRN is the CRN of the DNS Services instance managing the DNS zone for the cluster's base domain type: string region: @@ -2599,7 +2599,7 @@ spec: - External type: string vsphere: - description: VSphere contains settings specific to the + description: vsphere contains settings specific to the VSphere infrastructure provider. properties: apiServerInternalIP: @@ -2731,15 +2731,15 @@ spec: format: byte type: string network: - description: Network contains additional network related information + description: network contains additional network related information nullable: true properties: mtuMigration: - description: MTUMigration contains the MTU migration configuration. + description: mtuMigration contains the MTU migration configuration. nullable: true properties: machine: - description: Machine contains MTU migration configuration + description: machine contains MTU migration configuration for the machine's uplink. properties: from: @@ -2754,7 +2754,7 @@ spec: type: integer type: object network: - description: Network contains MTU migration configuration + description: network contains MTU migration configuration for the default network. properties: from: @@ -2781,7 +2781,7 @@ spec: regeneration if this changes. type: string osImageURL: - description: OSImageURL is the old-format container image that contains + description: osImageURL is the old-format container image that contains the OS update payload. type: string platform: diff --git a/payload-manifests/crds/0000_80_machine-config_01_controllerconfigs-TechPreviewNoUpgrade.crd.yaml b/payload-manifests/crds/0000_80_machine-config_01_controllerconfigs-TechPreviewNoUpgrade.crd.yaml index b9366fe0373..a935a973d61 100644 --- a/payload-manifests/crds/0000_80_machine-config_01_controllerconfigs-TechPreviewNoUpgrade.crd.yaml +++ b/payload-manifests/crds/0000_80_machine-config_01_controllerconfigs-TechPreviewNoUpgrade.crd.yaml @@ -56,11 +56,11 @@ spec: nullable: true type: string baseOSContainerImage: - description: BaseOSContainerImage is the new-format container image + description: baseOSContainerImage is the new-format container image for operating system updates. type: string baseOSExtensionsContainerImage: - description: BaseOSExtensionsContainerImage is the matching extensions + description: baseOSExtensionsContainerImage is the matching extensions container for the new-format container type: string cloudProviderCAData: @@ -337,7 +337,7 @@ spec: All the clients are expected to use the generated ConfigMap only. properties: key: - description: Key allows pointing to a specific key/value + description: key allows pointing to a specific key/value inside of the configmap. This is useful for logical file references. type: string @@ -350,11 +350,11 @@ spec: infrastructure provider. properties: alibabaCloud: - description: AlibabaCloud contains settings specific to + description: alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. type: object aws: - description: AWS contains settings specific to the Amazon + description: aws contains settings specific to the Amazon Web Services infrastructure provider. properties: serviceEndpoints: @@ -386,11 +386,11 @@ spec: x-kubernetes-list-type: atomic type: object azure: - description: Azure contains settings specific to the Azure + description: azure contains settings specific to the Azure infrastructure provider. type: object baremetal: - description: BareMetal contains settings specific to the + description: baremetal contains settings specific to the BareMetal platform. properties: apiServerInternalIPs: @@ -477,7 +477,7 @@ spec: - message: ingressIPs list is required once set rule: '!has(oldSelf.ingressIPs) || has(self.ingressIPs)' equinixMetal: - description: EquinixMetal contains settings specific to + description: equinixMetal contains settings specific to the Equinix Metal infrastructure provider. type: object external: @@ -488,7 +488,7 @@ spec: platformName: default: Unknown description: |- - PlatformName holds the arbitrary string representing the infrastructure provider name, expected to be set at the installation time. + 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 x-kubernetes-validations: @@ -496,19 +496,19 @@ spec: rule: oldSelf == 'Unknown' || self == oldSelf type: object gcp: - description: GCP contains settings specific to the Google + description: gcp contains settings specific to the Google Cloud Platform infrastructure provider. type: object ibmcloud: - description: IBMCloud contains settings specific to the + description: ibmcloud contains settings specific to the IBMCloud infrastructure provider. type: object kubevirt: - description: Kubevirt contains settings specific to the + description: kubevirt contains settings specific to the kubevirt infrastructure provider. type: object nutanix: - description: Nutanix contains settings specific to the + description: nutanix contains settings specific to the Nutanix infrastructure provider. properties: failureDomains: @@ -703,7 +703,7 @@ spec: - prismElements type: object openstack: - description: OpenStack contains settings specific to the + description: openstack contains settings specific to the OpenStack infrastructure provider. properties: apiServerInternalIPs: @@ -790,11 +790,11 @@ spec: - message: ingressIPs list is required once set rule: '!has(oldSelf.ingressIPs) || has(self.ingressIPs)' ovirt: - description: Ovirt contains settings specific to the oVirt + description: ovirt contains settings specific to the oVirt infrastructure provider. type: object powervs: - description: PowerVS contains settings specific to the + description: powervs contains settings specific to the IBM Power Systems Virtual Servers infrastructure provider. properties: serviceEndpoints: @@ -876,7 +876,7 @@ spec: - External type: string vsphere: - description: VSphere contains settings specific to the + description: vsphere contains settings specific to the VSphere infrastructure provider. properties: apiServerInternalIPs: @@ -958,7 +958,7 @@ spec: minLength: 1 type: string topology: - description: Topology describes a given failure + description: topology describes a given failure domain using vSphere constructs properties: computeCluster: @@ -1410,7 +1410,7 @@ spec: infrastructure provider. properties: alibabaCloud: - description: AlibabaCloud contains settings specific to + description: alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. properties: region: @@ -1454,7 +1454,7 @@ spec: - region type: object aws: - description: AWS contains settings specific to the Amazon + description: aws contains settings specific to the Amazon Web Services infrastructure provider. properties: cloudLoadBalancerConfig: @@ -1599,7 +1599,7 @@ spec: x-kubernetes-list-type: atomic serviceEndpoints: description: |- - ServiceEndpoints list contains custom endpoints which will override default + serviceEndpoints list contains custom endpoints which will override default service endpoint of AWS Services. There must be only one ServiceEndpoint for a service. items: @@ -1626,7 +1626,7 @@ spec: x-kubernetes-list-type: atomic type: object azure: - description: Azure contains settings specific to the Azure + description: azure contains settings specific to the Azure infrastructure provider. properties: armEndpoint: @@ -1702,7 +1702,7 @@ spec: rule: '!has(oldSelf.resourceTags) && !has(self.resourceTags) || has(oldSelf.resourceTags) && has(self.resourceTags)' baremetal: - description: BareMetal contains settings specific to the + description: baremetal contains settings specific to the BareMetal platform. properties: apiServerInternalIP: @@ -1812,7 +1812,7 @@ spec: type: string type: object equinixMetal: - description: EquinixMetal contains settings specific to + description: equinixMetal contains settings specific to the Equinix Metal infrastructure provider. properties: apiServerInternalIP: @@ -1829,7 +1829,7 @@ spec: type: string type: object external: - description: External contains settings specific to the + description: external contains settings specific to the generic External infrastructure provider. properties: cloudControllerManager: @@ -1869,7 +1869,7 @@ spec: removed once set rule: has(self.cloudControllerManager) == has(oldSelf.cloudControllerManager) gcp: - description: GCP contains settings specific to the Google + description: gcp contains settings specific to the Google Cloud Platform infrastructure provider. properties: cloudLoadBalancerConfig: @@ -2097,29 +2097,29 @@ spec: rule: '!has(oldSelf.resourceTags) && !has(self.resourceTags) || has(oldSelf.resourceTags) && has(self.resourceTags)' ibmcloud: - description: IBMCloud contains settings specific to the + description: ibmcloud contains settings specific to the IBMCloud infrastructure provider. properties: cisInstanceCRN: description: |- - CISInstanceCRN is the CRN of the Cloud Internet Services instance managing + 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 + 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 + description: location is where the cluster has been deployed type: string providerType: - description: ProviderType indicates the type of cluster + description: providerType indicates the type of cluster that was created type: string resourceGroupName: - description: ResourceGroupName is the Resource Group + description: resourceGroupName is the Resource Group for new IBMCloud resources created for the cluster. type: string serviceEndpoints: @@ -2174,7 +2174,7 @@ spec: x-kubernetes-list-type: map type: object kubevirt: - description: Kubevirt contains settings specific to the + description: kubevirt contains settings specific to the kubevirt infrastructure provider. properties: apiServerInternalIP: @@ -2191,7 +2191,7 @@ spec: type: string type: object nutanix: - description: Nutanix contains settings specific to the + description: nutanix contains settings specific to the Nutanix infrastructure provider. properties: apiServerInternalIP: @@ -2275,7 +2275,7 @@ spec: type: object type: object openstack: - description: OpenStack contains settings specific to the + description: openstack contains settings specific to the OpenStack infrastructure provider. properties: apiServerInternalIP: @@ -2390,7 +2390,7 @@ spec: type: string type: object ovirt: - description: Ovirt contains settings specific to the oVirt + description: ovirt contains settings specific to the oVirt infrastructure provider. properties: apiServerInternalIP: @@ -2479,17 +2479,17 @@ spec: type: string type: object powervs: - description: PowerVS contains settings specific to the + description: powervs contains settings specific to the Power Systems Virtual Servers infrastructure provider. properties: cisInstanceCRN: description: |- - CISInstanceCRN is the CRN of the Cloud Internet Services instance managing + 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 + dnsInstanceCRN is the CRN of the DNS Services instance managing the DNS zone for the cluster's base domain type: string region: @@ -2599,7 +2599,7 @@ spec: - External type: string vsphere: - description: VSphere contains settings specific to the + description: vsphere contains settings specific to the VSphere infrastructure provider. properties: apiServerInternalIP: @@ -2731,15 +2731,15 @@ spec: format: byte type: string network: - description: Network contains additional network related information + description: network contains additional network related information nullable: true properties: mtuMigration: - description: MTUMigration contains the MTU migration configuration. + description: mtuMigration contains the MTU migration configuration. nullable: true properties: machine: - description: Machine contains MTU migration configuration + description: machine contains MTU migration configuration for the machine's uplink. properties: from: @@ -2754,7 +2754,7 @@ spec: type: integer type: object network: - description: Network contains MTU migration configuration + description: network contains MTU migration configuration for the default network. properties: from: @@ -2781,7 +2781,7 @@ spec: regeneration if this changes. type: string osImageURL: - description: OSImageURL is the old-format container image that contains + description: osImageURL is the old-format container image that contains the OS update payload. type: string platform: diff --git a/payload-manifests/crds/0000_80_machine-config_01_kubeletconfigs.crd.yaml b/payload-manifests/crds/0000_80_machine-config_01_kubeletconfigs.crd.yaml index 2da51f8c756..ef8e71377cb 100644 --- a/payload-manifests/crds/0000_80_machine-config_01_kubeletconfigs.crd.yaml +++ b/payload-manifests/crds/0000_80_machine-config_01_kubeletconfigs.crd.yaml @@ -61,7 +61,7 @@ spec: type: integer machineConfigPoolSelector: description: |- - MachineConfigPoolSelector selects which pools the KubeletConfig shoud apply to. + machineConfigPoolSelector selects which pools the KubeletConfig shoud apply to. A nil selector will result in no pools being selected. properties: matchExpressions: diff --git a/payload-manifests/crds/0000_80_machine-config_01_machineconfigs.crd.yaml b/payload-manifests/crds/0000_80_machine-config_01_machineconfigs.crd.yaml index f878dd7ed51..df90d44d023 100644 --- a/payload-manifests/crds/0000_80_machine-config_01_machineconfigs.crd.yaml +++ b/payload-manifests/crds/0000_80_machine-config_01_machineconfigs.crd.yaml @@ -63,11 +63,11 @@ spec: properties: baseOSExtensionsContainerImage: description: |- - BaseOSExtensionsContainerImage specifies the remote location that will be used + baseOSExtensionsContainerImage specifies the remote location that will be used to fetch the extensions container matching a new-format OS image type: string config: - description: Config is a Ignition Config object. + description: config is a Ignition Config object. type: object x-kubernetes-preserve-unknown-fields: true extensions: @@ -95,7 +95,7 @@ spec: type: string osImageURL: description: |- - OSImageURL specifies the remote location that will be used to + osImageURL specifies the remote location that will be used to fetch the OS. type: string type: object diff --git a/payload-manifests/crds/0000_80_machine-config_01_machineosbuilds-CustomNoUpgrade.crd.yaml b/payload-manifests/crds/0000_80_machine-config_01_machineosbuilds-CustomNoUpgrade.crd.yaml index aee396dfe32..b153e19ba28 100644 --- a/payload-manifests/crds/0000_80_machine-config_01_machineosbuilds-CustomNoUpgrade.crd.yaml +++ b/payload-manifests/crds/0000_80_machine-config_01_machineosbuilds-CustomNoUpgrade.crd.yaml @@ -170,7 +170,7 @@ spec: - resource type: object imageBuilderType: - description: ImageBuilderType describes the image builder set + description: imageBuilderType describes the image builder set in the MachineOSConfig type: string required: diff --git a/payload-manifests/crds/0000_80_machine-config_01_machineosbuilds-DevPreviewNoUpgrade.crd.yaml b/payload-manifests/crds/0000_80_machine-config_01_machineosbuilds-DevPreviewNoUpgrade.crd.yaml index 4cf5f001636..d64704b194e 100644 --- a/payload-manifests/crds/0000_80_machine-config_01_machineosbuilds-DevPreviewNoUpgrade.crd.yaml +++ b/payload-manifests/crds/0000_80_machine-config_01_machineosbuilds-DevPreviewNoUpgrade.crd.yaml @@ -170,7 +170,7 @@ spec: - resource type: object imageBuilderType: - description: ImageBuilderType describes the image builder set + description: imageBuilderType describes the image builder set in the MachineOSConfig type: string required: diff --git a/payload-manifests/crds/0000_80_machine-config_01_machineosbuilds-TechPreviewNoUpgrade.crd.yaml b/payload-manifests/crds/0000_80_machine-config_01_machineosbuilds-TechPreviewNoUpgrade.crd.yaml index 0e2fe374f10..886173c58e3 100644 --- a/payload-manifests/crds/0000_80_machine-config_01_machineosbuilds-TechPreviewNoUpgrade.crd.yaml +++ b/payload-manifests/crds/0000_80_machine-config_01_machineosbuilds-TechPreviewNoUpgrade.crd.yaml @@ -170,7 +170,7 @@ spec: - resource type: object imageBuilderType: - description: ImageBuilderType describes the image builder set + description: imageBuilderType describes the image builder set in the MachineOSConfig type: string required: diff --git a/platform/v1alpha1/types.go b/platform/v1alpha1/types.go index a4fccb1cf79..3b67d102700 100644 --- a/platform/v1alpha1/types.go +++ b/platform/v1alpha1/types.go @@ -12,7 +12,7 @@ type Package struct { // This configured package will be managed with the cluster's lifecycle. In // the current implementation, it will be retrieving this name from a list of // supported operators out of the catalogs included with OpenShift. - // +kubebuilder:validation:Required + // +required // // +kubebuilder:validation:Pattern:=[a-z0-9]([-a-z0-9]*[a-z0-9])? // +kubebuilder:validation:MaxLength:=56 @@ -27,14 +27,14 @@ type Package struct { type PlatformOperatorSpec struct { // package contains the desired package and its configuration for this // PlatformOperator. - // +kubebuilder:validation:Required + // +required Package Package `json:"package"` } // ActiveBundleDeployment references a BundleDeployment resource. type ActiveBundleDeployment struct { // name is the metadata.name of the referenced BundleDeployment object. - // +kubebuilder:validation:Required + // +required Name string `json:"name"` } diff --git a/project/v1/generated.proto b/project/v1/generated.proto index 762dc99c652..d1ffbc341bf 100644 --- a/project/v1/generated.proto +++ b/project/v1/generated.proto @@ -32,10 +32,10 @@ message Project { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata optional .k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1; - // Spec defines the behavior of the Namespace. + // spec defines the behavior of the Namespace. optional ProjectSpec spec = 2; - // Status describes the current status of a Namespace + // status describes the current status of a Namespace // +optional optional ProjectStatus status = 3; } @@ -49,7 +49,7 @@ message ProjectList { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata optional .k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1; - // Items is the list of projects + // items is the list of projects repeated Project items = 2; } @@ -62,22 +62,22 @@ message ProjectRequest { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata optional .k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1; - // DisplayName is the display name to apply to a project + // displayName is the display name to apply to a project optional string displayName = 2; - // Description is the description to apply to a project + // description is the description to apply to a project optional string description = 3; } // ProjectSpec describes the attributes on a Project message ProjectSpec { - // Finalizers is an opaque list of values that must be empty to permanently remove object from storage + // finalizers is an opaque list of values that must be empty to permanently remove object from storage repeated string finalizers = 1; } // ProjectStatus is information about the current status of a Project message ProjectStatus { - // Phase is the current lifecycle phase of the project + // phase is the current lifecycle phase of the project // +optional optional string phase = 1; diff --git a/project/v1/types.go b/project/v1/types.go index 9c17a5deab7..5e69b775b53 100644 --- a/project/v1/types.go +++ b/project/v1/types.go @@ -18,7 +18,7 @@ type ProjectList struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` - // Items is the list of projects + // items is the list of projects Items []Project `json:"items" protobuf:"bytes,2,rep,name=items"` } @@ -36,13 +36,13 @@ const ( // ProjectSpec describes the attributes on a Project type ProjectSpec struct { - // Finalizers is an opaque list of values that must be empty to permanently remove object from storage + // finalizers is an opaque list of values that must be empty to permanently remove object from storage Finalizers []corev1.FinalizerName `json:"finalizers,omitempty" protobuf:"bytes,1,rep,name=finalizers,casttype=k8s.io/api/core/v1.FinalizerName"` } // ProjectStatus is information about the current status of a Project type ProjectStatus struct { - // Phase is the current lifecycle phase of the project + // phase is the current lifecycle phase of the project // +optional Phase corev1.NamespacePhase `json:"phase,omitempty" protobuf:"bytes,1,opt,name=phase,casttype=k8s.io/api/core/v1.NamespacePhase"` @@ -79,10 +79,10 @@ type Project struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` - // Spec defines the behavior of the Namespace. + // spec defines the behavior of the Namespace. Spec ProjectSpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"` - // Status describes the current status of a Namespace + // status describes the current status of a Namespace // +optional Status ProjectStatus `json:"status,omitempty" protobuf:"bytes,3,opt,name=status"` } @@ -104,8 +104,8 @@ type ProjectRequest struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` - // DisplayName is the display name to apply to a project + // displayName is the display name to apply to a project DisplayName string `json:"displayName,omitempty" protobuf:"bytes,2,opt,name=displayName"` - // Description is the description to apply to a project + // description is the description to apply to a project Description string `json:"description,omitempty" protobuf:"bytes,3,opt,name=description"` } diff --git a/project/v1/zz_generated.swagger_doc_generated.go b/project/v1/zz_generated.swagger_doc_generated.go index 890e651d739..b764eaface1 100644 --- a/project/v1/zz_generated.swagger_doc_generated.go +++ b/project/v1/zz_generated.swagger_doc_generated.go @@ -14,8 +14,8 @@ package v1 var map_Project = map[string]string{ "": "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).", "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "spec": "Spec defines the behavior of the Namespace.", - "status": "Status describes the current status of a Namespace", + "spec": "spec defines the behavior of the Namespace.", + "status": "status describes the current status of a Namespace", } func (Project) SwaggerDoc() map[string]string { @@ -25,7 +25,7 @@ func (Project) SwaggerDoc() map[string]string { var map_ProjectList = map[string]string{ "": "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).", "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "items": "Items is the list of projects", + "items": "items is the list of projects", } func (ProjectList) SwaggerDoc() map[string]string { @@ -35,8 +35,8 @@ func (ProjectList) SwaggerDoc() map[string]string { var map_ProjectRequest = map[string]string{ "": "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).", "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "displayName": "DisplayName is the display name to apply to a project", - "description": "Description is the description to apply to a project", + "displayName": "displayName is the display name to apply to a project", + "description": "description is the description to apply to a project", } func (ProjectRequest) SwaggerDoc() map[string]string { @@ -45,7 +45,7 @@ func (ProjectRequest) SwaggerDoc() map[string]string { var map_ProjectSpec = map[string]string{ "": "ProjectSpec describes the attributes on a Project", - "finalizers": "Finalizers is an opaque list of values that must be empty to permanently remove object from storage", + "finalizers": "finalizers is an opaque list of values that must be empty to permanently remove object from storage", } func (ProjectSpec) SwaggerDoc() map[string]string { @@ -54,7 +54,7 @@ func (ProjectSpec) SwaggerDoc() map[string]string { var map_ProjectStatus = map[string]string{ "": "ProjectStatus is information about the current status of a Project", - "phase": "Phase is the current lifecycle phase of the project", + "phase": "phase is the current lifecycle phase of the project", "conditions": "Represents the latest available observations of the project current state.", } diff --git a/quota/v1/generated.proto b/quota/v1/generated.proto index d08e8f0f9a9..fb7fed242a8 100644 --- a/quota/v1/generated.proto +++ b/quota/v1/generated.proto @@ -23,10 +23,10 @@ message AppliedClusterResourceQuota { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata optional .k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1; - // Spec defines the desired quota + // spec defines the desired quota optional ClusterResourceQuotaSpec spec = 2; - // Status defines the actual enforced quota and its current usage + // status defines the actual enforced quota and its current usage optional ClusterResourceQuotaStatus status = 3; } @@ -39,7 +39,7 @@ message AppliedClusterResourceQuotaList { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata optional .k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1; - // Items is a list of AppliedClusterResourceQuota + // items is a list of AppliedClusterResourceQuota repeated AppliedClusterResourceQuota items = 2; } @@ -59,10 +59,10 @@ message ClusterResourceQuota { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata optional .k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1; - // Spec defines the desired quota + // spec defines the desired quota optional ClusterResourceQuotaSpec spec = 2; - // Status defines the actual enforced quota and its current usage + // status defines the actual enforced quota and its current usage optional ClusterResourceQuotaStatus status = 3; } @@ -75,7 +75,7 @@ message ClusterResourceQuotaList { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata optional .k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1; - // Items is a list of ClusterResourceQuotas + // items is a list of ClusterResourceQuotas repeated ClusterResourceQuota items = 2; } @@ -96,22 +96,22 @@ message ClusterResourceQuotaSelector { // ClusterResourceQuotaSpec defines the desired quota restrictions message ClusterResourceQuotaSpec { - // Selector is the selector used to match projects. + // 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. optional ClusterResourceQuotaSelector selector = 1; - // Quota defines the desired quota + // quota defines the desired quota optional .k8s.io.api.core.v1.ResourceQuotaSpec quota = 2; } // ClusterResourceQuotaStatus defines the actual enforced quota and its current usage message ClusterResourceQuotaStatus { - // Total defines the actual enforced quota and its current usage across all projects + // total defines the actual enforced quota and its current usage across all projects optional .k8s.io.api.core.v1.ResourceQuotaStatus total = 1; - // Namespaces slices the usage by project. This division allows for quick resolution of + // 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. // +optional @@ -121,10 +121,10 @@ message ClusterResourceQuotaStatus { // ResourceQuotaStatusByNamespace gives status for a particular project message ResourceQuotaStatusByNamespace { - // Namespace the project this status applies to + // namespace the project this status applies to optional string namespace = 1; - // Status indicates how many resources have been consumed by this project + // status indicates how many resources have been consumed by this project optional .k8s.io.api.core.v1.ResourceQuotaStatus status = 2; } diff --git a/quota/v1/types.go b/quota/v1/types.go index 7a29ddcd4b1..0cfb85f87e4 100644 --- a/quota/v1/types.go +++ b/quota/v1/types.go @@ -27,22 +27,22 @@ type ClusterResourceQuota struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata" protobuf:"bytes,1,opt,name=metadata"` - // Spec defines the desired quota + // spec defines the desired quota Spec ClusterResourceQuotaSpec `json:"spec" protobuf:"bytes,2,opt,name=spec"` - // Status defines the actual enforced quota and its current usage + // status defines the actual enforced quota and its current usage Status ClusterResourceQuotaStatus `json:"status,omitempty" protobuf:"bytes,3,opt,name=status"` } // ClusterResourceQuotaSpec defines the desired quota restrictions type ClusterResourceQuotaSpec struct { - // Selector is the selector used to match projects. + // 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. Selector ClusterResourceQuotaSelector `json:"selector" protobuf:"bytes,1,opt,name=selector"` - // Quota defines the desired quota + // quota defines the desired quota Quota corev1.ResourceQuotaSpec `json:"quota" protobuf:"bytes,2,opt,name=quota"` } @@ -63,10 +63,10 @@ type ClusterResourceQuotaSelector struct { // ClusterResourceQuotaStatus defines the actual enforced quota and its current usage type ClusterResourceQuotaStatus struct { - // Total defines the actual enforced quota and its current usage across all projects + // total defines the actual enforced quota and its current usage across all projects Total corev1.ResourceQuotaStatus `json:"total" protobuf:"bytes,1,opt,name=total"` - // Namespaces slices the usage by project. This division allows for quick resolution of + // 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. // +optional @@ -87,7 +87,7 @@ type ClusterResourceQuotaList struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` - // Items is a list of ClusterResourceQuotas + // items is a list of ClusterResourceQuotas Items []ClusterResourceQuota `json:"items" protobuf:"bytes,2,rep,name=items"` } @@ -96,10 +96,10 @@ type ResourceQuotasStatusByNamespace []ResourceQuotaStatusByNamespace // ResourceQuotaStatusByNamespace gives status for a particular project type ResourceQuotaStatusByNamespace struct { - // Namespace the project this status applies to + // namespace the project this status applies to Namespace string `json:"namespace" protobuf:"bytes,1,opt,name=namespace"` - // Status indicates how many resources have been consumed by this project + // status indicates how many resources have been consumed by this project Status corev1.ResourceQuotaStatus `json:"status" protobuf:"bytes,2,opt,name=status"` } @@ -120,10 +120,10 @@ type AppliedClusterResourceQuota struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata" protobuf:"bytes,1,opt,name=metadata"` - // Spec defines the desired quota + // spec defines the desired quota Spec ClusterResourceQuotaSpec `json:"spec" protobuf:"bytes,2,opt,name=spec"` - // Status defines the actual enforced quota and its current usage + // status defines the actual enforced quota and its current usage Status ClusterResourceQuotaStatus `json:"status,omitempty" protobuf:"bytes,3,opt,name=status"` } @@ -140,6 +140,6 @@ type AppliedClusterResourceQuotaList struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` - // Items is a list of AppliedClusterResourceQuota + // items is a list of AppliedClusterResourceQuota Items []AppliedClusterResourceQuota `json:"items" protobuf:"bytes,2,rep,name=items"` } diff --git a/quota/v1/zz_generated.crd-manifests/0000_03_config-operator_01_clusterresourcequotas.crd.yaml b/quota/v1/zz_generated.crd-manifests/0000_03_config-operator_01_clusterresourcequotas.crd.yaml index 862365b6727..fe6e1217312 100644 --- a/quota/v1/zz_generated.crd-manifests/0000_03_config-operator_01_clusterresourcequotas.crd.yaml +++ b/quota/v1/zz_generated.crd-manifests/0000_03_config-operator_01_clusterresourcequotas.crd.yaml @@ -44,10 +44,10 @@ spec: metadata: type: object spec: - description: Spec defines the desired quota + description: spec defines the desired quota properties: quota: - description: Quota defines the desired quota + description: quota defines the desired quota properties: hard: additionalProperties: @@ -114,7 +114,7 @@ spec: type: object selector: description: |- - Selector is the selector used to match projects. + 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. @@ -179,12 +179,12 @@ spec: - selector type: object status: - description: Status defines the actual enforced quota and its current + description: status defines the actual enforced quota and its current usage properties: namespaces: description: |- - Namespaces slices the usage by project. This division allows for quick resolution of + 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. items: @@ -192,10 +192,10 @@ spec: project properties: namespace: - description: Namespace the project this status applies to + description: namespace the project this status applies to type: string status: - description: Status indicates how many resources have been consumed + description: status indicates how many resources have been consumed by this project properties: hard: @@ -227,7 +227,7 @@ spec: nullable: true type: array total: - description: Total defines the actual enforced quota and its current + description: total defines the actual enforced quota and its current usage across all projects properties: hard: diff --git a/quota/v1/zz_generated.featuregated-crd-manifests/clusterresourcequotas.quota.openshift.io/AAA_ungated.yaml b/quota/v1/zz_generated.featuregated-crd-manifests/clusterresourcequotas.quota.openshift.io/AAA_ungated.yaml index 05f8a793ceb..e001fa0133f 100644 --- a/quota/v1/zz_generated.featuregated-crd-manifests/clusterresourcequotas.quota.openshift.io/AAA_ungated.yaml +++ b/quota/v1/zz_generated.featuregated-crd-manifests/clusterresourcequotas.quota.openshift.io/AAA_ungated.yaml @@ -45,10 +45,10 @@ spec: metadata: type: object spec: - description: Spec defines the desired quota + description: spec defines the desired quota properties: quota: - description: Quota defines the desired quota + description: quota defines the desired quota properties: hard: additionalProperties: @@ -115,7 +115,7 @@ spec: type: object selector: description: |- - Selector is the selector used to match projects. + 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. @@ -180,12 +180,12 @@ spec: - selector type: object status: - description: Status defines the actual enforced quota and its current + description: status defines the actual enforced quota and its current usage properties: namespaces: description: |- - Namespaces slices the usage by project. This division allows for quick resolution of + 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. items: @@ -193,10 +193,10 @@ spec: project properties: namespace: - description: Namespace the project this status applies to + description: namespace the project this status applies to type: string status: - description: Status indicates how many resources have been consumed + description: status indicates how many resources have been consumed by this project properties: hard: @@ -228,7 +228,7 @@ spec: nullable: true type: array total: - description: Total defines the actual enforced quota and its current + description: total defines the actual enforced quota and its current usage across all projects properties: hard: diff --git a/quota/v1/zz_generated.swagger_doc_generated.go b/quota/v1/zz_generated.swagger_doc_generated.go index 3072671c53f..1bb84b81764 100644 --- a/quota/v1/zz_generated.swagger_doc_generated.go +++ b/quota/v1/zz_generated.swagger_doc_generated.go @@ -14,8 +14,8 @@ package v1 var map_AppliedClusterResourceQuota = map[string]string{ "": "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).", "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "spec": "Spec defines the desired quota", - "status": "Status defines the actual enforced quota and its current usage", + "spec": "spec defines the desired quota", + "status": "status defines the actual enforced quota and its current usage", } func (AppliedClusterResourceQuota) SwaggerDoc() map[string]string { @@ -25,7 +25,7 @@ func (AppliedClusterResourceQuota) SwaggerDoc() map[string]string { var map_AppliedClusterResourceQuotaList = map[string]string{ "": "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).", "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "items": "Items is a list of AppliedClusterResourceQuota", + "items": "items is a list of AppliedClusterResourceQuota", } func (AppliedClusterResourceQuotaList) SwaggerDoc() map[string]string { @@ -35,8 +35,8 @@ func (AppliedClusterResourceQuotaList) SwaggerDoc() map[string]string { var map_ClusterResourceQuota = map[string]string{ "": "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).", "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "spec": "Spec defines the desired quota", - "status": "Status defines the actual enforced quota and its current usage", + "spec": "spec defines the desired quota", + "status": "status defines the actual enforced quota and its current usage", } func (ClusterResourceQuota) SwaggerDoc() map[string]string { @@ -46,7 +46,7 @@ func (ClusterResourceQuota) SwaggerDoc() map[string]string { var map_ClusterResourceQuotaList = map[string]string{ "": "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).", "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "items": "Items is a list of ClusterResourceQuotas", + "items": "items is a list of ClusterResourceQuotas", } func (ClusterResourceQuotaList) SwaggerDoc() map[string]string { @@ -65,8 +65,8 @@ func (ClusterResourceQuotaSelector) SwaggerDoc() map[string]string { var map_ClusterResourceQuotaSpec = map[string]string{ "": "ClusterResourceQuotaSpec defines the desired quota restrictions", - "selector": "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.", - "quota": "Quota defines the desired quota", + "selector": "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.", + "quota": "quota defines the desired quota", } func (ClusterResourceQuotaSpec) SwaggerDoc() map[string]string { @@ -75,8 +75,8 @@ func (ClusterResourceQuotaSpec) SwaggerDoc() map[string]string { var map_ClusterResourceQuotaStatus = map[string]string{ "": "ClusterResourceQuotaStatus defines the actual enforced quota and its current usage", - "total": "Total defines the actual enforced quota and its current usage across all projects", - "namespaces": "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.", + "total": "total defines the actual enforced quota and its current usage across all projects", + "namespaces": "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.", } func (ClusterResourceQuotaStatus) SwaggerDoc() map[string]string { @@ -85,8 +85,8 @@ func (ClusterResourceQuotaStatus) SwaggerDoc() map[string]string { var map_ResourceQuotaStatusByNamespace = map[string]string{ "": "ResourceQuotaStatusByNamespace gives status for a particular project", - "namespace": "Namespace the project this status applies to", - "status": "Status indicates how many resources have been consumed by this project", + "namespace": "namespace the project this status applies to", + "status": "status indicates how many resources have been consumed by this project", } func (ResourceQuotaStatusByNamespace) SwaggerDoc() map[string]string { diff --git a/route/v1/generated.proto b/route/v1/generated.proto index 2a79b9a5a03..d6e1845b401 100644 --- a/route/v1/generated.proto +++ b/route/v1/generated.proto @@ -74,7 +74,7 @@ message RouteHTTPHeader { // Strict-Transport-Security, Proxy, Cookie, Set-Cookie. // It must be no more than 255 characters in length. // Header name must be unique. - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=255 // +kubebuilder:validation:Pattern="^[-!#$%&'*+.0-9A-Z^_`a-z|~]+$" @@ -85,7 +85,7 @@ message RouteHTTPHeader { optional string name = 1; // action specifies actions to perform on headers, such as setting or deleting headers. - // +kubebuilder:validation:Required + // +required optional RouteHTTPHeaderActionUnion action = 2; } @@ -99,7 +99,7 @@ message RouteHTTPHeaderActionUnion { // Delete allows you to delete HTTP request and response headers. // +unionDiscriminator // +kubebuilder:validation:Enum:=Set;Delete - // +kubebuilder:validation:Required + // +required optional string type = 1; // set defines the HTTP header that should be set: added if it doesn't exist or replaced if it does. @@ -192,13 +192,13 @@ message RouteHTTPHeaders { // RouteIngress holds information about the places where a route is exposed. message RouteIngress { - // Host is the host string under which the route is exposed; this value is required + // host is the host string under which the route is exposed; this value is required optional string host = 1; // Name is a name chosen by the router to identify itself; this value is required optional string routerName = 2; - // Conditions is the state of the route, may be empty. + // conditions is the state of the route, may be empty. // +listType=map // +listMapKey=type repeated RouteIngressCondition conditions = 3; @@ -214,11 +214,11 @@ message RouteIngress { // RouteIngressCondition contains details for the current condition of this route on a particular // router. message RouteIngressCondition { - // Type is the type of the condition. + // type is the type of the condition. // Currently only Admitted or UnservableInFutureVersions. optional string type = 1; - // Status is the status of the condition. + // status is the status of the condition. // Can be True, False, Unknown. optional string status = 2; @@ -267,7 +267,7 @@ message RouteSetHTTPHeader { // + --- // + Note: This limit was selected as most common web servers have a limit of 16384 characters or some lower limit. // + See . - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=16384 optional string value = 1; diff --git a/route/v1/types.go b/route/v1/types.go index 9416199946c..8fc25087738 100644 --- a/route/v1/types.go +++ b/route/v1/types.go @@ -251,7 +251,7 @@ type RouteHTTPHeader struct { // Strict-Transport-Security, Proxy, Cookie, Set-Cookie. // It must be no more than 255 characters in length. // Header name must be unique. - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=255 // +kubebuilder:validation:Pattern="^[-!#$%&'*+.0-9A-Z^_`a-z|~]+$" @@ -262,7 +262,7 @@ type RouteHTTPHeader struct { Name string `json:"name" protobuf:"bytes,1,opt,name=name"` // action specifies actions to perform on headers, such as setting or deleting headers. - // +kubebuilder:validation:Required + // +required Action RouteHTTPHeaderActionUnion `json:"action" protobuf:"bytes,2,opt,name=action"` } @@ -276,7 +276,7 @@ type RouteHTTPHeaderActionUnion struct { // Delete allows you to delete HTTP request and response headers. // +unionDiscriminator // +kubebuilder:validation:Enum:=Set;Delete - // +kubebuilder:validation:Required + // +required Type RouteHTTPHeaderActionType `json:"type" protobuf:"bytes,1,opt,name=type,casttype=RouteHTTPHeaderActionType"` // set defines the HTTP header that should be set: added if it doesn't exist or replaced if it does. @@ -299,7 +299,7 @@ type RouteSetHTTPHeader struct { // + --- // + Note: This limit was selected as most common web servers have a limit of 16384 characters or some lower limit. // + See . - // +kubebuilder:validation:Required + // +required // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=16384 Value string `json:"value" protobuf:"bytes,1,opt,name=value"` @@ -359,11 +359,11 @@ type RouteStatus struct { // RouteIngress holds information about the places where a route is exposed. type RouteIngress struct { - // Host is the host string under which the route is exposed; this value is required + // host is the host string under which the route is exposed; this value is required Host string `json:"host,omitempty" protobuf:"bytes,1,opt,name=host"` // Name is a name chosen by the router to identify itself; this value is required RouterName string `json:"routerName,omitempty" protobuf:"bytes,2,opt,name=routerName"` - // Conditions is the state of the route, may be empty. + // conditions is the state of the route, may be empty. // +listType=map // +listMapKey=type Conditions []RouteIngressCondition `json:"conditions,omitempty" protobuf:"bytes,3,rep,name=conditions"` @@ -389,10 +389,10 @@ const ( // RouteIngressCondition contains details for the current condition of this route on a particular // router. type RouteIngressCondition struct { - // Type is the type of the condition. + // type is the type of the condition. // Currently only Admitted or UnservableInFutureVersions. Type RouteIngressConditionType `json:"type" protobuf:"bytes,1,opt,name=type,casttype=RouteIngressConditionType"` - // Status is the status of the condition. + // status is the status of the condition. // Can be True, False, Unknown. Status corev1.ConditionStatus `json:"status" protobuf:"bytes,2,opt,name=status,casttype=k8s.io/api/core/v1.ConditionStatus"` // (brief) reason for the condition's last transition, and is usually a machine and human diff --git a/route/v1/zz_generated.crd-manifests/routes-CustomNoUpgrade.crd.yaml b/route/v1/zz_generated.crd-manifests/routes-CustomNoUpgrade.crd.yaml index adfd5768876..8b6275475ee 100644 --- a/route/v1/zz_generated.crd-manifests/routes-CustomNoUpgrade.crd.yaml +++ b/route/v1/zz_generated.crd-manifests/routes-CustomNoUpgrade.crd.yaml @@ -624,7 +624,7 @@ spec: a route is exposed. properties: conditions: - description: Conditions is the state of the route, may be empty. + description: conditions is the state of the route, may be empty. items: description: |- RouteIngressCondition contains details for the current condition of this route on a particular @@ -646,12 +646,12 @@ spec: type: string status: description: |- - Status is the status of the condition. + status is the status of the condition. Can be True, False, Unknown. type: string type: description: |- - Type is the type of the condition. + type is the type of the condition. Currently only Admitted or UnservableInFutureVersions. type: string required: @@ -663,7 +663,7 @@ spec: - type x-kubernetes-list-type: map host: - description: Host is the host string under which the route is + description: host is the host string under which the route is exposed; this value is required type: string routerCanonicalHostname: diff --git a/route/v1/zz_generated.crd-manifests/routes-Default.crd.yaml b/route/v1/zz_generated.crd-manifests/routes-Default.crd.yaml index ed0665f53b6..b0d43a451f1 100644 --- a/route/v1/zz_generated.crd-manifests/routes-Default.crd.yaml +++ b/route/v1/zz_generated.crd-manifests/routes-Default.crd.yaml @@ -607,7 +607,7 @@ spec: a route is exposed. properties: conditions: - description: Conditions is the state of the route, may be empty. + description: conditions is the state of the route, may be empty. items: description: |- RouteIngressCondition contains details for the current condition of this route on a particular @@ -629,12 +629,12 @@ spec: type: string status: description: |- - Status is the status of the condition. + status is the status of the condition. Can be True, False, Unknown. type: string type: description: |- - Type is the type of the condition. + type is the type of the condition. Currently only Admitted or UnservableInFutureVersions. type: string required: @@ -646,7 +646,7 @@ spec: - type x-kubernetes-list-type: map host: - description: Host is the host string under which the route is + description: host is the host string under which the route is exposed; this value is required type: string routerCanonicalHostname: diff --git a/route/v1/zz_generated.crd-manifests/routes-DevPreviewNoUpgrade.crd.yaml b/route/v1/zz_generated.crd-manifests/routes-DevPreviewNoUpgrade.crd.yaml index 2feb287b1ed..c8b896775d0 100644 --- a/route/v1/zz_generated.crd-manifests/routes-DevPreviewNoUpgrade.crd.yaml +++ b/route/v1/zz_generated.crd-manifests/routes-DevPreviewNoUpgrade.crd.yaml @@ -624,7 +624,7 @@ spec: a route is exposed. properties: conditions: - description: Conditions is the state of the route, may be empty. + description: conditions is the state of the route, may be empty. items: description: |- RouteIngressCondition contains details for the current condition of this route on a particular @@ -646,12 +646,12 @@ spec: type: string status: description: |- - Status is the status of the condition. + status is the status of the condition. Can be True, False, Unknown. type: string type: description: |- - Type is the type of the condition. + type is the type of the condition. Currently only Admitted or UnservableInFutureVersions. type: string required: @@ -663,7 +663,7 @@ spec: - type x-kubernetes-list-type: map host: - description: Host is the host string under which the route is + description: host is the host string under which the route is exposed; this value is required type: string routerCanonicalHostname: diff --git a/route/v1/zz_generated.crd-manifests/routes-TechPreviewNoUpgrade.crd.yaml b/route/v1/zz_generated.crd-manifests/routes-TechPreviewNoUpgrade.crd.yaml index 6cef3e0f6c5..954a5518ad7 100644 --- a/route/v1/zz_generated.crd-manifests/routes-TechPreviewNoUpgrade.crd.yaml +++ b/route/v1/zz_generated.crd-manifests/routes-TechPreviewNoUpgrade.crd.yaml @@ -624,7 +624,7 @@ spec: a route is exposed. properties: conditions: - description: Conditions is the state of the route, may be empty. + description: conditions is the state of the route, may be empty. items: description: |- RouteIngressCondition contains details for the current condition of this route on a particular @@ -646,12 +646,12 @@ spec: type: string status: description: |- - Status is the status of the condition. + status is the status of the condition. Can be True, False, Unknown. type: string type: description: |- - Type is the type of the condition. + type is the type of the condition. Currently only Admitted or UnservableInFutureVersions. type: string required: @@ -663,7 +663,7 @@ spec: - type x-kubernetes-list-type: map host: - description: Host is the host string under which the route is + description: host is the host string under which the route is exposed; this value is required type: string routerCanonicalHostname: diff --git a/route/v1/zz_generated.featuregated-crd-manifests/routes.route.openshift.io/AAA_ungated.yaml b/route/v1/zz_generated.featuregated-crd-manifests/routes.route.openshift.io/AAA_ungated.yaml index faab3bb01cc..be62ef6231f 100644 --- a/route/v1/zz_generated.featuregated-crd-manifests/routes.route.openshift.io/AAA_ungated.yaml +++ b/route/v1/zz_generated.featuregated-crd-manifests/routes.route.openshift.io/AAA_ungated.yaml @@ -549,7 +549,7 @@ spec: a route is exposed. properties: conditions: - description: Conditions is the state of the route, may be empty. + description: conditions is the state of the route, may be empty. items: description: |- RouteIngressCondition contains details for the current condition of this route on a particular @@ -571,12 +571,12 @@ spec: type: string status: description: |- - Status is the status of the condition. + status is the status of the condition. Can be True, False, Unknown. type: string type: description: |- - Type is the type of the condition. + type is the type of the condition. Currently only Admitted or UnservableInFutureVersions. type: string required: @@ -588,7 +588,7 @@ spec: - type x-kubernetes-list-type: map host: - description: Host is the host string under which the route is + description: host is the host string under which the route is exposed; this value is required type: string routerCanonicalHostname: diff --git a/route/v1/zz_generated.featuregated-crd-manifests/routes.route.openshift.io/RouteExternalCertificate.yaml b/route/v1/zz_generated.featuregated-crd-manifests/routes.route.openshift.io/RouteExternalCertificate.yaml index 4fdca576332..097cbd7b891 100644 --- a/route/v1/zz_generated.featuregated-crd-manifests/routes.route.openshift.io/RouteExternalCertificate.yaml +++ b/route/v1/zz_generated.featuregated-crd-manifests/routes.route.openshift.io/RouteExternalCertificate.yaml @@ -566,7 +566,7 @@ spec: a route is exposed. properties: conditions: - description: Conditions is the state of the route, may be empty. + description: conditions is the state of the route, may be empty. items: description: |- RouteIngressCondition contains details for the current condition of this route on a particular @@ -588,12 +588,12 @@ spec: type: string status: description: |- - Status is the status of the condition. + status is the status of the condition. Can be True, False, Unknown. type: string type: description: |- - Type is the type of the condition. + type is the type of the condition. Currently only Admitted or UnservableInFutureVersions. type: string required: @@ -605,7 +605,7 @@ spec: - type x-kubernetes-list-type: map host: - description: Host is the host string under which the route is + description: host is the host string under which the route is exposed; this value is required type: string routerCanonicalHostname: diff --git a/route/v1/zz_generated.swagger_doc_generated.go b/route/v1/zz_generated.swagger_doc_generated.go index 56a4e23e3d5..1d59f103350 100644 --- a/route/v1/zz_generated.swagger_doc_generated.go +++ b/route/v1/zz_generated.swagger_doc_generated.go @@ -72,9 +72,9 @@ func (RouteHTTPHeaders) SwaggerDoc() map[string]string { var map_RouteIngress = map[string]string{ "": "RouteIngress holds information about the places where a route is exposed.", - "host": "Host is the host string under which the route is exposed; this value is required", + "host": "host is the host string under which the route is exposed; this value is required", "routerName": "Name is a name chosen by the router to identify itself; this value is required", - "conditions": "Conditions is the state of the route, may be empty.", + "conditions": "conditions is the state of the route, may be empty.", "wildcardPolicy": "Wildcard policy is the wildcard policy that was allowed where this route is exposed.", "routerCanonicalHostname": "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.", } @@ -85,8 +85,8 @@ func (RouteIngress) SwaggerDoc() map[string]string { var map_RouteIngressCondition = map[string]string{ "": "RouteIngressCondition contains details for the current condition of this route on a particular router.", - "type": "Type is the type of the condition. Currently only Admitted or UnservableInFutureVersions.", - "status": "Status is the status of the condition. Can be True, False, Unknown.", + "type": "type is the type of the condition. Currently only Admitted or UnservableInFutureVersions.", + "status": "status is the status of the condition. Can be True, False, Unknown.", "reason": "(brief) reason for the condition's last transition, and is usually a machine and human readable constant", "message": "Human readable message indicating details about last transition.", "lastTransitionTime": "RFC 3339 date and time when this condition last transitioned", diff --git a/samples/v1/generated.proto b/samples/v1/generated.proto index be97c467db1..eeda6835ae0 100644 --- a/samples/v1/generated.proto +++ b/samples/v1/generated.proto @@ -30,7 +30,6 @@ message Config { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata optional .k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1; - // +kubebuilder:validation:Required // +required optional ConfigSpec spec = 2; diff --git a/samples/v1/types_config.go b/samples/v1/types_config.go index c4bf380439c..320500b0ce6 100644 --- a/samples/v1/types_config.go +++ b/samples/v1/types_config.go @@ -29,7 +29,6 @@ type Config struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata" protobuf:"bytes,1,opt,name=metadata"` - // +kubebuilder:validation:Required // +required Spec ConfigSpec `json:"spec" protobuf:"bytes,2,opt,name=spec"` // +optional diff --git a/security/v1/generated.proto b/security/v1/generated.proto index fdb879ce0d1..0e6bb094fbc 100644 --- a/security/v1/generated.proto +++ b/security/v1/generated.proto @@ -14,16 +14,16 @@ option go_package = "github.com/openshift/api/security/v1"; // AllowedFlexVolume represents a single Flexvolume that is allowed to be used. message AllowedFlexVolume { - // Driver is the name of the Flexvolume driver. + // driver is the name of the Flexvolume driver. optional string driver = 1; } // FSGroupStrategyOptions defines the strategy type and options used to create the strategy. message FSGroupStrategyOptions { - // Type is the strategy that will dictate what FSGroup is used in the SecurityContext. + // type is the strategy that will dictate what FSGroup is used in the SecurityContext. optional string type = 1; - // Ranges are the allowed ranges of fs groups. If you would like to force a single + // 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. // +listType=atomic repeated IDRange ranges = 2; @@ -32,10 +32,10 @@ message FSGroupStrategyOptions { // IDRange provides a min/max of an allowed range of IDs. // TODO: this could be reused for UIDs. message IDRange { - // Min is the start of the range, inclusive. + // min is the start of the range, inclusive. optional int64 min = 1; - // Max is the end of the range, inclusive. + // max is the end of the range, inclusive. optional int64 max = 2; } @@ -177,23 +177,23 @@ message RangeAllocationList { // RunAsUserStrategyOptions defines the strategy type and any options used to create the strategy. message RunAsUserStrategyOptions { - // Type is the strategy that will dictate what RunAsUser is used in the SecurityContext. + // type is the strategy that will dictate what RunAsUser is used in the SecurityContext. optional string type = 1; - // UID is the user id that containers must run as. Required for the MustRunAs strategy if not using + // uid is the user id that containers must run as. Required for the MustRunAs strategy if not using // namespace/service account allocated uids. optional int64 uid = 2; - // UIDRangeMin defines the min value for a strategy that allocates by range. + // uidRangeMin defines the min value for a strategy that allocates by range. optional int64 uidRangeMin = 3; - // UIDRangeMax defines the max value for a strategy that allocates by range. + // uidRangeMax defines the max value for a strategy that allocates by range. optional int64 uidRangeMax = 4; } // SELinuxContextStrategyOptions defines the strategy type and any options used to create the strategy. message SELinuxContextStrategyOptions { - // Type is the strategy that will dictate what SELinux context is used in the SecurityContext. + // type is the strategy that will dictate what SELinux context is used in the SecurityContext. optional string type = 1; // seLinuxOptions required to run as; required for MustRunAs @@ -229,7 +229,7 @@ message SecurityContextConstraints { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata optional .k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1; - // Priority influences the sort order of SCCs when evaluating which SCCs to try first for + // 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 @@ -238,23 +238,23 @@ message SecurityContextConstraints { // +nullable optional int32 priority = 2; - // AllowPrivilegedContainer determines if a container can request to be run as privileged. + // allowPrivilegedContainer determines if a container can request to be run as privileged. optional bool allowPrivilegedContainer = 3; - // DefaultAddCapabilities is the default set of capabilities that will be added to the container + // 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. // +nullable // +listType=atomic repeated string defaultAddCapabilities = 4; - // RequiredDropCapabilities are the capabilities that will be dropped from the container. These + // requiredDropCapabilities are the capabilities that will be dropped from the container. These // are required to be dropped and cannot be added. // +nullable // +listType=atomic repeated string requiredDropCapabilities = 5; - // AllowedCapabilities is a list of capabilities that can be requested to add to the container. + // 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 '*'. @@ -262,18 +262,18 @@ message SecurityContextConstraints { // +listType=atomic repeated string allowedCapabilities = 6; - // AllowHostDirVolumePlugin determines if the policy allow containers to use the HostDir volume plugin + // allowHostDirVolumePlugin determines if the policy allow containers to use the HostDir volume plugin // +k8s:conversion-gen=false optional bool allowHostDirVolumePlugin = 7; - // Volumes is a white list of allowed volume plugins. FSType corresponds directly with the field names + // 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"]. // +nullable // +listType=atomic repeated string volumes = 8; - // AllowedFlexVolumes is a whitelist of allowed Flexvolumes. Empty or nil indicates that all + // 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. // +optional @@ -281,16 +281,16 @@ message SecurityContextConstraints { // +listType=atomic repeated AllowedFlexVolume allowedFlexVolumes = 21; - // AllowHostNetwork determines if the policy allows the use of HostNetwork in the pod spec. + // allowHostNetwork determines if the policy allows the use of HostNetwork in the pod spec. optional bool allowHostNetwork = 9; - // AllowHostPorts determines if the policy allows host ports in the containers. + // allowHostPorts determines if the policy allows host ports in the containers. optional bool allowHostPorts = 10; - // AllowHostPID determines if the policy allows host pid in the containers. + // allowHostPID determines if the policy allows host pid in the containers. optional bool allowHostPID = 11; - // AllowHostIPC determines if the policy allows host ipc in the containers. + // allowHostIPC determines if the policy allows host ipc in the containers. optional bool allowHostIPC = 12; // userNamespaceLevel determines if the policy allows host users in containers. @@ -305,35 +305,35 @@ message SecurityContextConstraints { // +optional optional string userNamespaceLevel = 26; - // DefaultAllowPrivilegeEscalation controls the default setting for whether a + // defaultAllowPrivilegeEscalation controls the default setting for whether a // process can gain more privileges than its parent process. // +optional // +nullable optional bool defaultAllowPrivilegeEscalation = 22; - // AllowPrivilegeEscalation determines if a pod can request to allow + // allowPrivilegeEscalation determines if a pod can request to allow // privilege escalation. If unspecified, defaults to true. // +optional // +nullable optional bool allowPrivilegeEscalation = 23; - // SELinuxContext is the strategy that will dictate what labels will be set in the SecurityContext. + // seLinuxContext is the strategy that will dictate what labels will be set in the SecurityContext. // +nullable optional SELinuxContextStrategyOptions seLinuxContext = 13; - // RunAsUser is the strategy that will dictate what RunAsUser is used in the SecurityContext. + // runAsUser is the strategy that will dictate what RunAsUser is used in the SecurityContext. // +nullable optional RunAsUserStrategyOptions runAsUser = 14; - // SupplementalGroups is the strategy that will dictate what supplemental groups are used by the SecurityContext. + // supplementalGroups is the strategy that will dictate what supplemental groups are used by the SecurityContext. // +nullable optional SupplementalGroupsStrategyOptions supplementalGroups = 15; - // FSGroup is the strategy that will dictate what fs group is used by the SecurityContext. + // fsGroup is the strategy that will dictate what fs group is used by the SecurityContext. // +nullable optional FSGroupStrategyOptions fsGroup = 16; - // ReadOnlyRootFilesystem when set to true will force containers to run with a read only root file + // 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 @@ -352,7 +352,7 @@ message SecurityContextConstraints { // +listType=atomic repeated string groups = 19; - // SeccompProfiles lists the allowed profiles that may be set for the pod or + // 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. The 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 @@ -361,7 +361,7 @@ message SecurityContextConstraints { // +listType=atomic repeated string seccompProfiles = 20; - // AllowedUnsafeSysctls is a list of explicitly allowed unsafe sysctls, defaults to none. + // 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. @@ -374,7 +374,7 @@ message SecurityContextConstraints { // +listType=atomic repeated string allowedUnsafeSysctls = 24; - // ForbiddenSysctls is a list of explicitly forbidden sysctls, defaults to none. + // 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. // @@ -410,10 +410,10 @@ message ServiceAccountPodSecurityPolicyReviewStatus { // SupplementalGroupsStrategyOptions defines the strategy type and options used to create the strategy. message SupplementalGroupsStrategyOptions { - // Type is the strategy that will dictate what supplemental groups is used in the SecurityContext. + // type is the strategy that will dictate what supplemental groups is used in the SecurityContext. optional string type = 1; - // Ranges are the allowed ranges of supplemental groups. If you would like to force a single + // 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. // +listType=atomic repeated IDRange ranges = 2; diff --git a/security/v1/types.go b/security/v1/types.go index 9d0af5c8dd3..18585e97c04 100644 --- a/security/v1/types.go +++ b/security/v1/types.go @@ -45,7 +45,7 @@ type SecurityContextConstraints struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` - // Priority influences the sort order of SCCs when evaluating which SCCs to try first for + // 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 @@ -54,49 +54,49 @@ type SecurityContextConstraints struct { // +nullable Priority *int32 `json:"priority" protobuf:"varint,2,opt,name=priority"` - // AllowPrivilegedContainer determines if a container can request to be run as privileged. + // allowPrivilegedContainer determines if a container can request to be run as privileged. AllowPrivilegedContainer bool `json:"allowPrivilegedContainer" protobuf:"varint,3,opt,name=allowPrivilegedContainer"` - // DefaultAddCapabilities is the default set of capabilities that will be added to the container + // 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. // +nullable // +listType=atomic DefaultAddCapabilities []corev1.Capability `json:"defaultAddCapabilities" protobuf:"bytes,4,rep,name=defaultAddCapabilities,casttype=Capability"` - // RequiredDropCapabilities are the capabilities that will be dropped from the container. These + // requiredDropCapabilities are the capabilities that will be dropped from the container. These // are required to be dropped and cannot be added. // +nullable // +listType=atomic RequiredDropCapabilities []corev1.Capability `json:"requiredDropCapabilities" protobuf:"bytes,5,rep,name=requiredDropCapabilities,casttype=Capability"` - // AllowedCapabilities is a list of capabilities that can be requested to add to the container. + // 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 '*'. // +nullable // +listType=atomic AllowedCapabilities []corev1.Capability `json:"allowedCapabilities" protobuf:"bytes,6,rep,name=allowedCapabilities,casttype=Capability"` - // AllowHostDirVolumePlugin determines if the policy allow containers to use the HostDir volume plugin + // allowHostDirVolumePlugin determines if the policy allow containers to use the HostDir volume plugin // +k8s:conversion-gen=false AllowHostDirVolumePlugin bool `json:"allowHostDirVolumePlugin" protobuf:"varint,7,opt,name=allowHostDirVolumePlugin"` - // Volumes is a white list of allowed volume plugins. FSType corresponds directly with the field names + // 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"]. // +nullable // +listType=atomic Volumes []FSType `json:"volumes" protobuf:"bytes,8,rep,name=volumes,casttype=FSType"` - // AllowedFlexVolumes is a whitelist of allowed Flexvolumes. Empty or nil indicates that all + // 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. // +optional // +nullable // +listType=atomic AllowedFlexVolumes []AllowedFlexVolume `json:"allowedFlexVolumes,omitempty" protobuf:"bytes,21,rep,name=allowedFlexVolumes"` - // AllowHostNetwork determines if the policy allows the use of HostNetwork in the pod spec. + // allowHostNetwork determines if the policy allows the use of HostNetwork in the pod spec. AllowHostNetwork bool `json:"allowHostNetwork" protobuf:"varint,9,opt,name=allowHostNetwork"` - // AllowHostPorts determines if the policy allows host ports in the containers. + // allowHostPorts determines if the policy allows host ports in the containers. AllowHostPorts bool `json:"allowHostPorts" protobuf:"varint,10,opt,name=allowHostPorts"` - // AllowHostPID determines if the policy allows host pid in the containers. + // allowHostPID determines if the policy allows host pid in the containers. AllowHostPID bool `json:"allowHostPID" protobuf:"varint,11,opt,name=allowHostPID"` - // AllowHostIPC determines if the policy allows host ipc in the containers. + // allowHostIPC determines if the policy allows host ipc in the containers. AllowHostIPC bool `json:"allowHostIPC" protobuf:"varint,12,opt,name=allowHostIPC"` // userNamespaceLevel determines if the policy allows host users in containers. // Valid values are "AllowHostLevel", "RequirePodLevel", and omitted. @@ -109,29 +109,29 @@ type SecurityContextConstraints struct { // +default="AllowHostLevel" // +optional UserNamespaceLevel NamespaceLevelType `json:"userNamespaceLevel,omitempty" protobuf:"bytes,26,opt,name=userNamespaceLevel"` - // DefaultAllowPrivilegeEscalation controls the default setting for whether a + // defaultAllowPrivilegeEscalation controls the default setting for whether a // process can gain more privileges than its parent process. // +optional // +nullable DefaultAllowPrivilegeEscalation *bool `json:"defaultAllowPrivilegeEscalation,omitempty" protobuf:"varint,22,rep,name=defaultAllowPrivilegeEscalation"` - // AllowPrivilegeEscalation determines if a pod can request to allow + // allowPrivilegeEscalation determines if a pod can request to allow // privilege escalation. If unspecified, defaults to true. // +optional // +nullable AllowPrivilegeEscalation *bool `json:"allowPrivilegeEscalation,omitempty" protobuf:"varint,23,rep,name=allowPrivilegeEscalation"` - // SELinuxContext is the strategy that will dictate what labels will be set in the SecurityContext. + // seLinuxContext is the strategy that will dictate what labels will be set in the SecurityContext. // +nullable SELinuxContext SELinuxContextStrategyOptions `json:"seLinuxContext,omitempty" protobuf:"bytes,13,opt,name=seLinuxContext"` - // RunAsUser is the strategy that will dictate what RunAsUser is used in the SecurityContext. + // runAsUser is the strategy that will dictate what RunAsUser is used in the SecurityContext. // +nullable RunAsUser RunAsUserStrategyOptions `json:"runAsUser,omitempty" protobuf:"bytes,14,opt,name=runAsUser"` - // SupplementalGroups is the strategy that will dictate what supplemental groups are used by the SecurityContext. + // supplementalGroups is the strategy that will dictate what supplemental groups are used by the SecurityContext. // +nullable SupplementalGroups SupplementalGroupsStrategyOptions `json:"supplementalGroups,omitempty" protobuf:"bytes,15,opt,name=supplementalGroups"` - // FSGroup is the strategy that will dictate what fs group is used by the SecurityContext. + // fsGroup is the strategy that will dictate what fs group is used by the SecurityContext. // +nullable FSGroup FSGroupStrategyOptions `json:"fsGroup,omitempty" protobuf:"bytes,16,opt,name=fsGroup"` - // ReadOnlyRootFilesystem when set to true will force containers to run with a read only root file + // 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 @@ -149,7 +149,7 @@ type SecurityContextConstraints struct { // +listType=atomic Groups []string `json:"groups" protobuf:"bytes,19,rep,name=groups"` - // SeccompProfiles lists the allowed profiles that may be set for the pod or + // 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. The 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 @@ -158,7 +158,7 @@ type SecurityContextConstraints struct { // +listType=atomic SeccompProfiles []string `json:"seccompProfiles,omitempty" protobuf:"bytes,20,opt,name=seccompProfiles"` - // AllowedUnsafeSysctls is a list of explicitly allowed unsafe sysctls, defaults to none. + // 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. @@ -170,7 +170,7 @@ type SecurityContextConstraints struct { // +nullable // +listType=atomic AllowedUnsafeSysctls []string `json:"allowedUnsafeSysctls,omitempty" protobuf:"bytes,24,rep,name=allowedUnsafeSysctls"` - // ForbiddenSysctls is a list of explicitly forbidden sysctls, defaults to none. + // 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. // @@ -223,13 +223,13 @@ var ( // AllowedFlexVolume represents a single Flexvolume that is allowed to be used. type AllowedFlexVolume struct { - // Driver is the name of the Flexvolume driver. + // driver is the name of the Flexvolume driver. Driver string `json:"driver" protobuf:"bytes,1,opt,name=driver"` } // SELinuxContextStrategyOptions defines the strategy type and any options used to create the strategy. type SELinuxContextStrategyOptions struct { - // Type is the strategy that will dictate what SELinux context is used in the SecurityContext. + // type is the strategy that will dictate what SELinux context is used in the SecurityContext. Type SELinuxContextStrategyType `json:"type,omitempty" protobuf:"bytes,1,opt,name=type,casttype=SELinuxContextStrategyType"` // seLinuxOptions required to run as; required for MustRunAs SELinuxOptions *corev1.SELinuxOptions `json:"seLinuxOptions,omitempty" protobuf:"bytes,2,opt,name=seLinuxOptions"` @@ -237,22 +237,22 @@ type SELinuxContextStrategyOptions struct { // RunAsUserStrategyOptions defines the strategy type and any options used to create the strategy. type RunAsUserStrategyOptions struct { - // Type is the strategy that will dictate what RunAsUser is used in the SecurityContext. + // type is the strategy that will dictate what RunAsUser is used in the SecurityContext. Type RunAsUserStrategyType `json:"type,omitempty" protobuf:"bytes,1,opt,name=type,casttype=RunAsUserStrategyType"` - // UID is the user id that containers must run as. Required for the MustRunAs strategy if not using + // uid is the user id that containers must run as. Required for the MustRunAs strategy if not using // namespace/service account allocated uids. UID *int64 `json:"uid,omitempty" protobuf:"varint,2,opt,name=uid"` - // UIDRangeMin defines the min value for a strategy that allocates by range. + // uidRangeMin defines the min value for a strategy that allocates by range. UIDRangeMin *int64 `json:"uidRangeMin,omitempty" protobuf:"varint,3,opt,name=uidRangeMin"` - // UIDRangeMax defines the max value for a strategy that allocates by range. + // uidRangeMax defines the max value for a strategy that allocates by range. UIDRangeMax *int64 `json:"uidRangeMax,omitempty" protobuf:"varint,4,opt,name=uidRangeMax"` } // FSGroupStrategyOptions defines the strategy type and options used to create the strategy. type FSGroupStrategyOptions struct { - // Type is the strategy that will dictate what FSGroup is used in the SecurityContext. + // type is the strategy that will dictate what FSGroup is used in the SecurityContext. Type FSGroupStrategyType `json:"type,omitempty" protobuf:"bytes,1,opt,name=type,casttype=FSGroupStrategyType"` - // Ranges are the allowed ranges of fs groups. If you would like to force a single + // 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. // +listType=atomic Ranges []IDRange `json:"ranges,omitempty" protobuf:"bytes,2,rep,name=ranges"` @@ -260,9 +260,9 @@ type FSGroupStrategyOptions struct { // SupplementalGroupsStrategyOptions defines the strategy type and options used to create the strategy. type SupplementalGroupsStrategyOptions struct { - // Type is the strategy that will dictate what supplemental groups is used in the SecurityContext. + // type is the strategy that will dictate what supplemental groups is used in the SecurityContext. Type SupplementalGroupsStrategyType `json:"type,omitempty" protobuf:"bytes,1,opt,name=type,casttype=SupplementalGroupsStrategyType"` - // Ranges are the allowed ranges of supplemental groups. If you would like to force a single + // 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. // +listType=atomic Ranges []IDRange `json:"ranges,omitempty" protobuf:"bytes,2,rep,name=ranges"` @@ -271,9 +271,9 @@ type SupplementalGroupsStrategyOptions struct { // IDRange provides a min/max of an allowed range of IDs. // TODO: this could be reused for UIDs. type IDRange struct { - // Min is the start of the range, inclusive. + // min is the start of the range, inclusive. Min int64 `json:"min,omitempty" protobuf:"varint,1,opt,name=min"` - // Max is the end of the range, inclusive. + // max is the end of the range, inclusive. Max int64 `json:"max,omitempty" protobuf:"varint,2,opt,name=max"` } diff --git a/security/v1/zz_generated.crd-manifests/0000_03_config-operator_01_securitycontextconstraints-CustomNoUpgrade.crd.yaml b/security/v1/zz_generated.crd-manifests/0000_03_config-operator_01_securitycontextconstraints-CustomNoUpgrade.crd.yaml index 853e6e331a7..9c7cb41f64a 100644 --- a/security/v1/zz_generated.crd-manifests/0000_03_config-operator_01_securitycontextconstraints-CustomNoUpgrade.crd.yaml +++ b/security/v1/zz_generated.crd-manifests/0000_03_config-operator_01_securitycontextconstraints-CustomNoUpgrade.crd.yaml @@ -70,38 +70,38 @@ spec: Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). properties: allowHostDirVolumePlugin: - description: AllowHostDirVolumePlugin determines if the policy allow containers + description: allowHostDirVolumePlugin determines if the policy allow containers to use the HostDir volume plugin type: boolean allowHostIPC: - description: AllowHostIPC determines if the policy allows host ipc in + description: allowHostIPC determines if the policy allows host ipc in the containers. type: boolean allowHostNetwork: - description: AllowHostNetwork determines if the policy allows the use + description: allowHostNetwork determines if the policy allows the use of HostNetwork in the pod spec. type: boolean allowHostPID: - description: AllowHostPID determines if the policy allows host pid in + description: allowHostPID determines if the policy allows host pid in the containers. type: boolean allowHostPorts: - description: AllowHostPorts determines if the policy allows host ports + description: allowHostPorts determines if the policy allows host ports in the containers. type: boolean allowPrivilegeEscalation: description: |- - AllowPrivilegeEscalation determines if a pod can request to allow + allowPrivilegeEscalation determines if a pod can request to allow privilege escalation. If unspecified, defaults to true. nullable: true type: boolean allowPrivilegedContainer: - description: AllowPrivilegedContainer determines if a container can request + description: allowPrivilegedContainer determines if a container can request to be run as privileged. type: boolean allowedCapabilities: description: |- - AllowedCapabilities is a list of capabilities that can be requested to add to the container. + 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 '*'. @@ -113,7 +113,7 @@ spec: x-kubernetes-list-type: atomic allowedFlexVolumes: description: |- - AllowedFlexVolumes is a whitelist of allowed Flexvolumes. Empty or nil indicates that all + 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. items: @@ -121,7 +121,7 @@ spec: allowed to be used. properties: driver: - description: Driver is the name of the Flexvolume driver. + description: driver is the name of the Flexvolume driver. type: string required: - driver @@ -131,7 +131,7 @@ spec: x-kubernetes-list-type: atomic allowedUnsafeSysctls: description: |- - AllowedUnsafeSysctls is a list of explicitly allowed unsafe sysctls, defaults to none. + 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. @@ -153,7 +153,7 @@ spec: type: string defaultAddCapabilities: description: |- - DefaultAddCapabilities is the default set of capabilities that will be added to the container + 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. items: @@ -164,13 +164,13 @@ spec: x-kubernetes-list-type: atomic defaultAllowPrivilegeEscalation: description: |- - DefaultAllowPrivilegeEscalation controls the default setting for whether a + defaultAllowPrivilegeEscalation controls the default setting for whether a process can gain more privileges than its parent process. nullable: true type: boolean forbiddenSysctls: description: |- - ForbiddenSysctls is a list of explicitly forbidden sysctls, defaults to none. + 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. @@ -183,30 +183,30 @@ spec: type: array x-kubernetes-list-type: atomic fsGroup: - description: FSGroup is the strategy that will dictate what fs group is + description: fsGroup is the strategy that will dictate what fs group is used by the SecurityContext. nullable: true properties: ranges: description: |- - Ranges are the allowed ranges of fs groups. If you would like to force a single + 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. items: description: IDRange provides a min/max of an allowed range of IDs. properties: max: - description: Max is the end of the range, inclusive. + description: max is the end of the range, inclusive. format: int64 type: integer min: - description: Min is the start of the range, inclusive. + description: min is the start of the range, inclusive. format: int64 type: integer type: object type: array x-kubernetes-list-type: atomic type: - description: Type is the strategy that will dictate what FSGroup is + description: type is the strategy that will dictate what FSGroup is used in the SecurityContext. type: string type: object @@ -230,7 +230,7 @@ spec: type: object priority: description: |- - Priority influences the sort order of SCCs when evaluating which SCCs to try first for + 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 @@ -241,7 +241,7 @@ spec: type: integer readOnlyRootFilesystem: description: |- - ReadOnlyRootFilesystem when set to true will force containers to run with a read only root file + 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 @@ -249,7 +249,7 @@ spec: type: boolean requiredDropCapabilities: description: |- - RequiredDropCapabilities are the capabilities that will be dropped from the container. These + requiredDropCapabilities are the capabilities that will be dropped from the container. These are required to be dropped and cannot be added. items: description: Capability represent POSIX capabilities type @@ -258,33 +258,33 @@ spec: type: array x-kubernetes-list-type: atomic runAsUser: - description: RunAsUser is the strategy that will dictate what RunAsUser + description: runAsUser is the strategy that will dictate what RunAsUser is used in the SecurityContext. nullable: true properties: type: - description: Type is the strategy that will dictate what RunAsUser + description: type is the strategy that will dictate what RunAsUser is used in the SecurityContext. type: string uid: description: |- - UID is the user id that containers must run as. Required for the MustRunAs strategy if not using + uid is the user id that containers must run as. Required for the MustRunAs strategy if not using namespace/service account allocated uids. format: int64 type: integer uidRangeMax: - description: UIDRangeMax defines the max value for a strategy that + description: uidRangeMax defines the max value for a strategy that allocates by range. format: int64 type: integer uidRangeMin: - description: UIDRangeMin defines the min value for a strategy that + description: uidRangeMin defines the min value for a strategy that allocates by range. format: int64 type: integer type: object seLinuxContext: - description: SELinuxContext is the strategy that will dictate what labels + description: seLinuxContext is the strategy that will dictate what labels will be set in the SecurityContext. nullable: true properties: @@ -309,12 +309,12 @@ spec: type: string type: object type: - description: Type is the strategy that will dictate what SELinux context + description: type is the strategy that will dictate what SELinux context is used in the SecurityContext. type: string type: object seccompProfiles: - description: "SeccompProfiles lists the allowed profiles that may be set + description: "seccompProfiles lists the allowed profiles that may be set for the pod or\ncontainer's seccomp annotations. An unset (nil) or empty value means that no profiles may\nbe specifid by the pod or container.\tThe wildcard '*' may be used to allow all profiles. When\nused to generate @@ -326,30 +326,30 @@ spec: type: array x-kubernetes-list-type: atomic supplementalGroups: - description: SupplementalGroups is the strategy that will dictate what + description: supplementalGroups is the strategy that will dictate what supplemental groups are used by the SecurityContext. nullable: true properties: ranges: description: |- - Ranges are the allowed ranges of supplemental groups. If you would like to force a single + 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. items: description: IDRange provides a min/max of an allowed range of IDs. properties: max: - description: Max is the end of the range, inclusive. + description: max is the end of the range, inclusive. format: int64 type: integer min: - description: Min is the start of the range, inclusive. + description: min is the start of the range, inclusive. format: int64 type: integer type: object type: array x-kubernetes-list-type: atomic type: - description: Type is the strategy that will dictate what supplemental + description: type is the strategy that will dictate what supplemental groups is used in the SecurityContext. type: string type: object @@ -375,7 +375,7 @@ spec: x-kubernetes-list-type: atomic volumes: description: |- - Volumes is a white list of allowed volume plugins. FSType corresponds directly with the field names + 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"]. items: diff --git a/security/v1/zz_generated.crd-manifests/0000_03_config-operator_01_securitycontextconstraints-Default.crd.yaml b/security/v1/zz_generated.crd-manifests/0000_03_config-operator_01_securitycontextconstraints-Default.crd.yaml index 9064d78d913..2d171c6d853 100644 --- a/security/v1/zz_generated.crd-manifests/0000_03_config-operator_01_securitycontextconstraints-Default.crd.yaml +++ b/security/v1/zz_generated.crd-manifests/0000_03_config-operator_01_securitycontextconstraints-Default.crd.yaml @@ -70,38 +70,38 @@ spec: Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). properties: allowHostDirVolumePlugin: - description: AllowHostDirVolumePlugin determines if the policy allow containers + description: allowHostDirVolumePlugin determines if the policy allow containers to use the HostDir volume plugin type: boolean allowHostIPC: - description: AllowHostIPC determines if the policy allows host ipc in + description: allowHostIPC determines if the policy allows host ipc in the containers. type: boolean allowHostNetwork: - description: AllowHostNetwork determines if the policy allows the use + description: allowHostNetwork determines if the policy allows the use of HostNetwork in the pod spec. type: boolean allowHostPID: - description: AllowHostPID determines if the policy allows host pid in + description: allowHostPID determines if the policy allows host pid in the containers. type: boolean allowHostPorts: - description: AllowHostPorts determines if the policy allows host ports + description: allowHostPorts determines if the policy allows host ports in the containers. type: boolean allowPrivilegeEscalation: description: |- - AllowPrivilegeEscalation determines if a pod can request to allow + allowPrivilegeEscalation determines if a pod can request to allow privilege escalation. If unspecified, defaults to true. nullable: true type: boolean allowPrivilegedContainer: - description: AllowPrivilegedContainer determines if a container can request + description: allowPrivilegedContainer determines if a container can request to be run as privileged. type: boolean allowedCapabilities: description: |- - AllowedCapabilities is a list of capabilities that can be requested to add to the container. + 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 '*'. @@ -113,7 +113,7 @@ spec: x-kubernetes-list-type: atomic allowedFlexVolumes: description: |- - AllowedFlexVolumes is a whitelist of allowed Flexvolumes. Empty or nil indicates that all + 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. items: @@ -121,7 +121,7 @@ spec: allowed to be used. properties: driver: - description: Driver is the name of the Flexvolume driver. + description: driver is the name of the Flexvolume driver. type: string required: - driver @@ -131,7 +131,7 @@ spec: x-kubernetes-list-type: atomic allowedUnsafeSysctls: description: |- - AllowedUnsafeSysctls is a list of explicitly allowed unsafe sysctls, defaults to none. + 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. @@ -153,7 +153,7 @@ spec: type: string defaultAddCapabilities: description: |- - DefaultAddCapabilities is the default set of capabilities that will be added to the container + 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. items: @@ -164,13 +164,13 @@ spec: x-kubernetes-list-type: atomic defaultAllowPrivilegeEscalation: description: |- - DefaultAllowPrivilegeEscalation controls the default setting for whether a + defaultAllowPrivilegeEscalation controls the default setting for whether a process can gain more privileges than its parent process. nullable: true type: boolean forbiddenSysctls: description: |- - ForbiddenSysctls is a list of explicitly forbidden sysctls, defaults to none. + 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. @@ -183,30 +183,30 @@ spec: type: array x-kubernetes-list-type: atomic fsGroup: - description: FSGroup is the strategy that will dictate what fs group is + description: fsGroup is the strategy that will dictate what fs group is used by the SecurityContext. nullable: true properties: ranges: description: |- - Ranges are the allowed ranges of fs groups. If you would like to force a single + 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. items: description: IDRange provides a min/max of an allowed range of IDs. properties: max: - description: Max is the end of the range, inclusive. + description: max is the end of the range, inclusive. format: int64 type: integer min: - description: Min is the start of the range, inclusive. + description: min is the start of the range, inclusive. format: int64 type: integer type: object type: array x-kubernetes-list-type: atomic type: - description: Type is the strategy that will dictate what FSGroup is + description: type is the strategy that will dictate what FSGroup is used in the SecurityContext. type: string type: object @@ -230,7 +230,7 @@ spec: type: object priority: description: |- - Priority influences the sort order of SCCs when evaluating which SCCs to try first for + 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 @@ -241,7 +241,7 @@ spec: type: integer readOnlyRootFilesystem: description: |- - ReadOnlyRootFilesystem when set to true will force containers to run with a read only root file + 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 @@ -249,7 +249,7 @@ spec: type: boolean requiredDropCapabilities: description: |- - RequiredDropCapabilities are the capabilities that will be dropped from the container. These + requiredDropCapabilities are the capabilities that will be dropped from the container. These are required to be dropped and cannot be added. items: description: Capability represent POSIX capabilities type @@ -258,33 +258,33 @@ spec: type: array x-kubernetes-list-type: atomic runAsUser: - description: RunAsUser is the strategy that will dictate what RunAsUser + description: runAsUser is the strategy that will dictate what RunAsUser is used in the SecurityContext. nullable: true properties: type: - description: Type is the strategy that will dictate what RunAsUser + description: type is the strategy that will dictate what RunAsUser is used in the SecurityContext. type: string uid: description: |- - UID is the user id that containers must run as. Required for the MustRunAs strategy if not using + uid is the user id that containers must run as. Required for the MustRunAs strategy if not using namespace/service account allocated uids. format: int64 type: integer uidRangeMax: - description: UIDRangeMax defines the max value for a strategy that + description: uidRangeMax defines the max value for a strategy that allocates by range. format: int64 type: integer uidRangeMin: - description: UIDRangeMin defines the min value for a strategy that + description: uidRangeMin defines the min value for a strategy that allocates by range. format: int64 type: integer type: object seLinuxContext: - description: SELinuxContext is the strategy that will dictate what labels + description: seLinuxContext is the strategy that will dictate what labels will be set in the SecurityContext. nullable: true properties: @@ -309,12 +309,12 @@ spec: type: string type: object type: - description: Type is the strategy that will dictate what SELinux context + description: type is the strategy that will dictate what SELinux context is used in the SecurityContext. type: string type: object seccompProfiles: - description: "SeccompProfiles lists the allowed profiles that may be set + description: "seccompProfiles lists the allowed profiles that may be set for the pod or\ncontainer's seccomp annotations. An unset (nil) or empty value means that no profiles may\nbe specifid by the pod or container.\tThe wildcard '*' may be used to allow all profiles. When\nused to generate @@ -326,30 +326,30 @@ spec: type: array x-kubernetes-list-type: atomic supplementalGroups: - description: SupplementalGroups is the strategy that will dictate what + description: supplementalGroups is the strategy that will dictate what supplemental groups are used by the SecurityContext. nullable: true properties: ranges: description: |- - Ranges are the allowed ranges of supplemental groups. If you would like to force a single + 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. items: description: IDRange provides a min/max of an allowed range of IDs. properties: max: - description: Max is the end of the range, inclusive. + description: max is the end of the range, inclusive. format: int64 type: integer min: - description: Min is the start of the range, inclusive. + description: min is the start of the range, inclusive. format: int64 type: integer type: object type: array x-kubernetes-list-type: atomic type: - description: Type is the strategy that will dictate what supplemental + description: type is the strategy that will dictate what supplemental groups is used in the SecurityContext. type: string type: object @@ -363,7 +363,7 @@ spec: x-kubernetes-list-type: atomic volumes: description: |- - Volumes is a white list of allowed volume plugins. FSType corresponds directly with the field names + 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"]. items: diff --git a/security/v1/zz_generated.crd-manifests/0000_03_config-operator_01_securitycontextconstraints-DevPreviewNoUpgrade.crd.yaml b/security/v1/zz_generated.crd-manifests/0000_03_config-operator_01_securitycontextconstraints-DevPreviewNoUpgrade.crd.yaml index b008141865d..301329c8dd0 100644 --- a/security/v1/zz_generated.crd-manifests/0000_03_config-operator_01_securitycontextconstraints-DevPreviewNoUpgrade.crd.yaml +++ b/security/v1/zz_generated.crd-manifests/0000_03_config-operator_01_securitycontextconstraints-DevPreviewNoUpgrade.crd.yaml @@ -70,38 +70,38 @@ spec: Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). properties: allowHostDirVolumePlugin: - description: AllowHostDirVolumePlugin determines if the policy allow containers + description: allowHostDirVolumePlugin determines if the policy allow containers to use the HostDir volume plugin type: boolean allowHostIPC: - description: AllowHostIPC determines if the policy allows host ipc in + description: allowHostIPC determines if the policy allows host ipc in the containers. type: boolean allowHostNetwork: - description: AllowHostNetwork determines if the policy allows the use + description: allowHostNetwork determines if the policy allows the use of HostNetwork in the pod spec. type: boolean allowHostPID: - description: AllowHostPID determines if the policy allows host pid in + description: allowHostPID determines if the policy allows host pid in the containers. type: boolean allowHostPorts: - description: AllowHostPorts determines if the policy allows host ports + description: allowHostPorts determines if the policy allows host ports in the containers. type: boolean allowPrivilegeEscalation: description: |- - AllowPrivilegeEscalation determines if a pod can request to allow + allowPrivilegeEscalation determines if a pod can request to allow privilege escalation. If unspecified, defaults to true. nullable: true type: boolean allowPrivilegedContainer: - description: AllowPrivilegedContainer determines if a container can request + description: allowPrivilegedContainer determines if a container can request to be run as privileged. type: boolean allowedCapabilities: description: |- - AllowedCapabilities is a list of capabilities that can be requested to add to the container. + 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 '*'. @@ -113,7 +113,7 @@ spec: x-kubernetes-list-type: atomic allowedFlexVolumes: description: |- - AllowedFlexVolumes is a whitelist of allowed Flexvolumes. Empty or nil indicates that all + 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. items: @@ -121,7 +121,7 @@ spec: allowed to be used. properties: driver: - description: Driver is the name of the Flexvolume driver. + description: driver is the name of the Flexvolume driver. type: string required: - driver @@ -131,7 +131,7 @@ spec: x-kubernetes-list-type: atomic allowedUnsafeSysctls: description: |- - AllowedUnsafeSysctls is a list of explicitly allowed unsafe sysctls, defaults to none. + 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. @@ -153,7 +153,7 @@ spec: type: string defaultAddCapabilities: description: |- - DefaultAddCapabilities is the default set of capabilities that will be added to the container + 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. items: @@ -164,13 +164,13 @@ spec: x-kubernetes-list-type: atomic defaultAllowPrivilegeEscalation: description: |- - DefaultAllowPrivilegeEscalation controls the default setting for whether a + defaultAllowPrivilegeEscalation controls the default setting for whether a process can gain more privileges than its parent process. nullable: true type: boolean forbiddenSysctls: description: |- - ForbiddenSysctls is a list of explicitly forbidden sysctls, defaults to none. + 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. @@ -183,30 +183,30 @@ spec: type: array x-kubernetes-list-type: atomic fsGroup: - description: FSGroup is the strategy that will dictate what fs group is + description: fsGroup is the strategy that will dictate what fs group is used by the SecurityContext. nullable: true properties: ranges: description: |- - Ranges are the allowed ranges of fs groups. If you would like to force a single + 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. items: description: IDRange provides a min/max of an allowed range of IDs. properties: max: - description: Max is the end of the range, inclusive. + description: max is the end of the range, inclusive. format: int64 type: integer min: - description: Min is the start of the range, inclusive. + description: min is the start of the range, inclusive. format: int64 type: integer type: object type: array x-kubernetes-list-type: atomic type: - description: Type is the strategy that will dictate what FSGroup is + description: type is the strategy that will dictate what FSGroup is used in the SecurityContext. type: string type: object @@ -230,7 +230,7 @@ spec: type: object priority: description: |- - Priority influences the sort order of SCCs when evaluating which SCCs to try first for + 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 @@ -241,7 +241,7 @@ spec: type: integer readOnlyRootFilesystem: description: |- - ReadOnlyRootFilesystem when set to true will force containers to run with a read only root file + 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 @@ -249,7 +249,7 @@ spec: type: boolean requiredDropCapabilities: description: |- - RequiredDropCapabilities are the capabilities that will be dropped from the container. These + requiredDropCapabilities are the capabilities that will be dropped from the container. These are required to be dropped and cannot be added. items: description: Capability represent POSIX capabilities type @@ -258,33 +258,33 @@ spec: type: array x-kubernetes-list-type: atomic runAsUser: - description: RunAsUser is the strategy that will dictate what RunAsUser + description: runAsUser is the strategy that will dictate what RunAsUser is used in the SecurityContext. nullable: true properties: type: - description: Type is the strategy that will dictate what RunAsUser + description: type is the strategy that will dictate what RunAsUser is used in the SecurityContext. type: string uid: description: |- - UID is the user id that containers must run as. Required for the MustRunAs strategy if not using + uid is the user id that containers must run as. Required for the MustRunAs strategy if not using namespace/service account allocated uids. format: int64 type: integer uidRangeMax: - description: UIDRangeMax defines the max value for a strategy that + description: uidRangeMax defines the max value for a strategy that allocates by range. format: int64 type: integer uidRangeMin: - description: UIDRangeMin defines the min value for a strategy that + description: uidRangeMin defines the min value for a strategy that allocates by range. format: int64 type: integer type: object seLinuxContext: - description: SELinuxContext is the strategy that will dictate what labels + description: seLinuxContext is the strategy that will dictate what labels will be set in the SecurityContext. nullable: true properties: @@ -309,12 +309,12 @@ spec: type: string type: object type: - description: Type is the strategy that will dictate what SELinux context + description: type is the strategy that will dictate what SELinux context is used in the SecurityContext. type: string type: object seccompProfiles: - description: "SeccompProfiles lists the allowed profiles that may be set + description: "seccompProfiles lists the allowed profiles that may be set for the pod or\ncontainer's seccomp annotations. An unset (nil) or empty value means that no profiles may\nbe specifid by the pod or container.\tThe wildcard '*' may be used to allow all profiles. When\nused to generate @@ -326,30 +326,30 @@ spec: type: array x-kubernetes-list-type: atomic supplementalGroups: - description: SupplementalGroups is the strategy that will dictate what + description: supplementalGroups is the strategy that will dictate what supplemental groups are used by the SecurityContext. nullable: true properties: ranges: description: |- - Ranges are the allowed ranges of supplemental groups. If you would like to force a single + 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. items: description: IDRange provides a min/max of an allowed range of IDs. properties: max: - description: Max is the end of the range, inclusive. + description: max is the end of the range, inclusive. format: int64 type: integer min: - description: Min is the start of the range, inclusive. + description: min is the start of the range, inclusive. format: int64 type: integer type: object type: array x-kubernetes-list-type: atomic type: - description: Type is the strategy that will dictate what supplemental + description: type is the strategy that will dictate what supplemental groups is used in the SecurityContext. type: string type: object @@ -375,7 +375,7 @@ spec: x-kubernetes-list-type: atomic volumes: description: |- - Volumes is a white list of allowed volume plugins. FSType corresponds directly with the field names + 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"]. items: diff --git a/security/v1/zz_generated.crd-manifests/0000_03_config-operator_01_securitycontextconstraints-TechPreviewNoUpgrade.crd.yaml b/security/v1/zz_generated.crd-manifests/0000_03_config-operator_01_securitycontextconstraints-TechPreviewNoUpgrade.crd.yaml index ab99396f3ac..a10601e8844 100644 --- a/security/v1/zz_generated.crd-manifests/0000_03_config-operator_01_securitycontextconstraints-TechPreviewNoUpgrade.crd.yaml +++ b/security/v1/zz_generated.crd-manifests/0000_03_config-operator_01_securitycontextconstraints-TechPreviewNoUpgrade.crd.yaml @@ -70,38 +70,38 @@ spec: Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). properties: allowHostDirVolumePlugin: - description: AllowHostDirVolumePlugin determines if the policy allow containers + description: allowHostDirVolumePlugin determines if the policy allow containers to use the HostDir volume plugin type: boolean allowHostIPC: - description: AllowHostIPC determines if the policy allows host ipc in + description: allowHostIPC determines if the policy allows host ipc in the containers. type: boolean allowHostNetwork: - description: AllowHostNetwork determines if the policy allows the use + description: allowHostNetwork determines if the policy allows the use of HostNetwork in the pod spec. type: boolean allowHostPID: - description: AllowHostPID determines if the policy allows host pid in + description: allowHostPID determines if the policy allows host pid in the containers. type: boolean allowHostPorts: - description: AllowHostPorts determines if the policy allows host ports + description: allowHostPorts determines if the policy allows host ports in the containers. type: boolean allowPrivilegeEscalation: description: |- - AllowPrivilegeEscalation determines if a pod can request to allow + allowPrivilegeEscalation determines if a pod can request to allow privilege escalation. If unspecified, defaults to true. nullable: true type: boolean allowPrivilegedContainer: - description: AllowPrivilegedContainer determines if a container can request + description: allowPrivilegedContainer determines if a container can request to be run as privileged. type: boolean allowedCapabilities: description: |- - AllowedCapabilities is a list of capabilities that can be requested to add to the container. + 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 '*'. @@ -113,7 +113,7 @@ spec: x-kubernetes-list-type: atomic allowedFlexVolumes: description: |- - AllowedFlexVolumes is a whitelist of allowed Flexvolumes. Empty or nil indicates that all + 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. items: @@ -121,7 +121,7 @@ spec: allowed to be used. properties: driver: - description: Driver is the name of the Flexvolume driver. + description: driver is the name of the Flexvolume driver. type: string required: - driver @@ -131,7 +131,7 @@ spec: x-kubernetes-list-type: atomic allowedUnsafeSysctls: description: |- - AllowedUnsafeSysctls is a list of explicitly allowed unsafe sysctls, defaults to none. + 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. @@ -153,7 +153,7 @@ spec: type: string defaultAddCapabilities: description: |- - DefaultAddCapabilities is the default set of capabilities that will be added to the container + 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. items: @@ -164,13 +164,13 @@ spec: x-kubernetes-list-type: atomic defaultAllowPrivilegeEscalation: description: |- - DefaultAllowPrivilegeEscalation controls the default setting for whether a + defaultAllowPrivilegeEscalation controls the default setting for whether a process can gain more privileges than its parent process. nullable: true type: boolean forbiddenSysctls: description: |- - ForbiddenSysctls is a list of explicitly forbidden sysctls, defaults to none. + 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. @@ -183,30 +183,30 @@ spec: type: array x-kubernetes-list-type: atomic fsGroup: - description: FSGroup is the strategy that will dictate what fs group is + description: fsGroup is the strategy that will dictate what fs group is used by the SecurityContext. nullable: true properties: ranges: description: |- - Ranges are the allowed ranges of fs groups. If you would like to force a single + 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. items: description: IDRange provides a min/max of an allowed range of IDs. properties: max: - description: Max is the end of the range, inclusive. + description: max is the end of the range, inclusive. format: int64 type: integer min: - description: Min is the start of the range, inclusive. + description: min is the start of the range, inclusive. format: int64 type: integer type: object type: array x-kubernetes-list-type: atomic type: - description: Type is the strategy that will dictate what FSGroup is + description: type is the strategy that will dictate what FSGroup is used in the SecurityContext. type: string type: object @@ -230,7 +230,7 @@ spec: type: object priority: description: |- - Priority influences the sort order of SCCs when evaluating which SCCs to try first for + 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 @@ -241,7 +241,7 @@ spec: type: integer readOnlyRootFilesystem: description: |- - ReadOnlyRootFilesystem when set to true will force containers to run with a read only root file + 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 @@ -249,7 +249,7 @@ spec: type: boolean requiredDropCapabilities: description: |- - RequiredDropCapabilities are the capabilities that will be dropped from the container. These + requiredDropCapabilities are the capabilities that will be dropped from the container. These are required to be dropped and cannot be added. items: description: Capability represent POSIX capabilities type @@ -258,33 +258,33 @@ spec: type: array x-kubernetes-list-type: atomic runAsUser: - description: RunAsUser is the strategy that will dictate what RunAsUser + description: runAsUser is the strategy that will dictate what RunAsUser is used in the SecurityContext. nullable: true properties: type: - description: Type is the strategy that will dictate what RunAsUser + description: type is the strategy that will dictate what RunAsUser is used in the SecurityContext. type: string uid: description: |- - UID is the user id that containers must run as. Required for the MustRunAs strategy if not using + uid is the user id that containers must run as. Required for the MustRunAs strategy if not using namespace/service account allocated uids. format: int64 type: integer uidRangeMax: - description: UIDRangeMax defines the max value for a strategy that + description: uidRangeMax defines the max value for a strategy that allocates by range. format: int64 type: integer uidRangeMin: - description: UIDRangeMin defines the min value for a strategy that + description: uidRangeMin defines the min value for a strategy that allocates by range. format: int64 type: integer type: object seLinuxContext: - description: SELinuxContext is the strategy that will dictate what labels + description: seLinuxContext is the strategy that will dictate what labels will be set in the SecurityContext. nullable: true properties: @@ -309,12 +309,12 @@ spec: type: string type: object type: - description: Type is the strategy that will dictate what SELinux context + description: type is the strategy that will dictate what SELinux context is used in the SecurityContext. type: string type: object seccompProfiles: - description: "SeccompProfiles lists the allowed profiles that may be set + description: "seccompProfiles lists the allowed profiles that may be set for the pod or\ncontainer's seccomp annotations. An unset (nil) or empty value means that no profiles may\nbe specifid by the pod or container.\tThe wildcard '*' may be used to allow all profiles. When\nused to generate @@ -326,30 +326,30 @@ spec: type: array x-kubernetes-list-type: atomic supplementalGroups: - description: SupplementalGroups is the strategy that will dictate what + description: supplementalGroups is the strategy that will dictate what supplemental groups are used by the SecurityContext. nullable: true properties: ranges: description: |- - Ranges are the allowed ranges of supplemental groups. If you would like to force a single + 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. items: description: IDRange provides a min/max of an allowed range of IDs. properties: max: - description: Max is the end of the range, inclusive. + description: max is the end of the range, inclusive. format: int64 type: integer min: - description: Min is the start of the range, inclusive. + description: min is the start of the range, inclusive. format: int64 type: integer type: object type: array x-kubernetes-list-type: atomic type: - description: Type is the strategy that will dictate what supplemental + description: type is the strategy that will dictate what supplemental groups is used in the SecurityContext. type: string type: object @@ -375,7 +375,7 @@ spec: x-kubernetes-list-type: atomic volumes: description: |- - Volumes is a white list of allowed volume plugins. FSType corresponds directly with the field names + 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"]. items: diff --git a/security/v1/zz_generated.featuregated-crd-manifests/securitycontextconstraints.security.openshift.io/AAA_ungated.yaml b/security/v1/zz_generated.featuregated-crd-manifests/securitycontextconstraints.security.openshift.io/AAA_ungated.yaml index 216c39ac7a6..7316263d596 100644 --- a/security/v1/zz_generated.featuregated-crd-manifests/securitycontextconstraints.security.openshift.io/AAA_ungated.yaml +++ b/security/v1/zz_generated.featuregated-crd-manifests/securitycontextconstraints.security.openshift.io/AAA_ungated.yaml @@ -70,38 +70,38 @@ spec: Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). properties: allowHostDirVolumePlugin: - description: AllowHostDirVolumePlugin determines if the policy allow containers + description: allowHostDirVolumePlugin determines if the policy allow containers to use the HostDir volume plugin type: boolean allowHostIPC: - description: AllowHostIPC determines if the policy allows host ipc in + description: allowHostIPC determines if the policy allows host ipc in the containers. type: boolean allowHostNetwork: - description: AllowHostNetwork determines if the policy allows the use + description: allowHostNetwork determines if the policy allows the use of HostNetwork in the pod spec. type: boolean allowHostPID: - description: AllowHostPID determines if the policy allows host pid in + description: allowHostPID determines if the policy allows host pid in the containers. type: boolean allowHostPorts: - description: AllowHostPorts determines if the policy allows host ports + description: allowHostPorts determines if the policy allows host ports in the containers. type: boolean allowPrivilegeEscalation: description: |- - AllowPrivilegeEscalation determines if a pod can request to allow + allowPrivilegeEscalation determines if a pod can request to allow privilege escalation. If unspecified, defaults to true. nullable: true type: boolean allowPrivilegedContainer: - description: AllowPrivilegedContainer determines if a container can request + description: allowPrivilegedContainer determines if a container can request to be run as privileged. type: boolean allowedCapabilities: description: |- - AllowedCapabilities is a list of capabilities that can be requested to add to the container. + 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 '*'. @@ -113,7 +113,7 @@ spec: x-kubernetes-list-type: atomic allowedFlexVolumes: description: |- - AllowedFlexVolumes is a whitelist of allowed Flexvolumes. Empty or nil indicates that all + 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. items: @@ -121,7 +121,7 @@ spec: allowed to be used. properties: driver: - description: Driver is the name of the Flexvolume driver. + description: driver is the name of the Flexvolume driver. type: string required: - driver @@ -131,7 +131,7 @@ spec: x-kubernetes-list-type: atomic allowedUnsafeSysctls: description: |- - AllowedUnsafeSysctls is a list of explicitly allowed unsafe sysctls, defaults to none. + 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. @@ -153,7 +153,7 @@ spec: type: string defaultAddCapabilities: description: |- - DefaultAddCapabilities is the default set of capabilities that will be added to the container + 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. items: @@ -164,13 +164,13 @@ spec: x-kubernetes-list-type: atomic defaultAllowPrivilegeEscalation: description: |- - DefaultAllowPrivilegeEscalation controls the default setting for whether a + defaultAllowPrivilegeEscalation controls the default setting for whether a process can gain more privileges than its parent process. nullable: true type: boolean forbiddenSysctls: description: |- - ForbiddenSysctls is a list of explicitly forbidden sysctls, defaults to none. + 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. @@ -183,30 +183,30 @@ spec: type: array x-kubernetes-list-type: atomic fsGroup: - description: FSGroup is the strategy that will dictate what fs group is + description: fsGroup is the strategy that will dictate what fs group is used by the SecurityContext. nullable: true properties: ranges: description: |- - Ranges are the allowed ranges of fs groups. If you would like to force a single + 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. items: description: IDRange provides a min/max of an allowed range of IDs. properties: max: - description: Max is the end of the range, inclusive. + description: max is the end of the range, inclusive. format: int64 type: integer min: - description: Min is the start of the range, inclusive. + description: min is the start of the range, inclusive. format: int64 type: integer type: object type: array x-kubernetes-list-type: atomic type: - description: Type is the strategy that will dictate what FSGroup is + description: type is the strategy that will dictate what FSGroup is used in the SecurityContext. type: string type: object @@ -230,7 +230,7 @@ spec: type: object priority: description: |- - Priority influences the sort order of SCCs when evaluating which SCCs to try first for + 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 @@ -241,7 +241,7 @@ spec: type: integer readOnlyRootFilesystem: description: |- - ReadOnlyRootFilesystem when set to true will force containers to run with a read only root file + 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 @@ -249,7 +249,7 @@ spec: type: boolean requiredDropCapabilities: description: |- - RequiredDropCapabilities are the capabilities that will be dropped from the container. These + requiredDropCapabilities are the capabilities that will be dropped from the container. These are required to be dropped and cannot be added. items: description: Capability represent POSIX capabilities type @@ -258,33 +258,33 @@ spec: type: array x-kubernetes-list-type: atomic runAsUser: - description: RunAsUser is the strategy that will dictate what RunAsUser + description: runAsUser is the strategy that will dictate what RunAsUser is used in the SecurityContext. nullable: true properties: type: - description: Type is the strategy that will dictate what RunAsUser + description: type is the strategy that will dictate what RunAsUser is used in the SecurityContext. type: string uid: description: |- - UID is the user id that containers must run as. Required for the MustRunAs strategy if not using + uid is the user id that containers must run as. Required for the MustRunAs strategy if not using namespace/service account allocated uids. format: int64 type: integer uidRangeMax: - description: UIDRangeMax defines the max value for a strategy that + description: uidRangeMax defines the max value for a strategy that allocates by range. format: int64 type: integer uidRangeMin: - description: UIDRangeMin defines the min value for a strategy that + description: uidRangeMin defines the min value for a strategy that allocates by range. format: int64 type: integer type: object seLinuxContext: - description: SELinuxContext is the strategy that will dictate what labels + description: seLinuxContext is the strategy that will dictate what labels will be set in the SecurityContext. nullable: true properties: @@ -309,12 +309,12 @@ spec: type: string type: object type: - description: Type is the strategy that will dictate what SELinux context + description: type is the strategy that will dictate what SELinux context is used in the SecurityContext. type: string type: object seccompProfiles: - description: "SeccompProfiles lists the allowed profiles that may be set + description: "seccompProfiles lists the allowed profiles that may be set for the pod or\ncontainer's seccomp annotations. An unset (nil) or empty value means that no profiles may\nbe specifid by the pod or container.\tThe wildcard '*' may be used to allow all profiles. When\nused to generate @@ -326,30 +326,30 @@ spec: type: array x-kubernetes-list-type: atomic supplementalGroups: - description: SupplementalGroups is the strategy that will dictate what + description: supplementalGroups is the strategy that will dictate what supplemental groups are used by the SecurityContext. nullable: true properties: ranges: description: |- - Ranges are the allowed ranges of supplemental groups. If you would like to force a single + 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. items: description: IDRange provides a min/max of an allowed range of IDs. properties: max: - description: Max is the end of the range, inclusive. + description: max is the end of the range, inclusive. format: int64 type: integer min: - description: Min is the start of the range, inclusive. + description: min is the start of the range, inclusive. format: int64 type: integer type: object type: array x-kubernetes-list-type: atomic type: - description: Type is the strategy that will dictate what supplemental + description: type is the strategy that will dictate what supplemental groups is used in the SecurityContext. type: string type: object @@ -363,7 +363,7 @@ spec: x-kubernetes-list-type: atomic volumes: description: |- - Volumes is a white list of allowed volume plugins. FSType corresponds directly with the field names + 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"]. items: diff --git a/security/v1/zz_generated.featuregated-crd-manifests/securitycontextconstraints.security.openshift.io/UserNamespacesPodSecurityStandards.yaml b/security/v1/zz_generated.featuregated-crd-manifests/securitycontextconstraints.security.openshift.io/UserNamespacesPodSecurityStandards.yaml index 24cf9f80f49..dea8d21b21e 100644 --- a/security/v1/zz_generated.featuregated-crd-manifests/securitycontextconstraints.security.openshift.io/UserNamespacesPodSecurityStandards.yaml +++ b/security/v1/zz_generated.featuregated-crd-manifests/securitycontextconstraints.security.openshift.io/UserNamespacesPodSecurityStandards.yaml @@ -70,38 +70,38 @@ spec: Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). properties: allowHostDirVolumePlugin: - description: AllowHostDirVolumePlugin determines if the policy allow containers + description: allowHostDirVolumePlugin determines if the policy allow containers to use the HostDir volume plugin type: boolean allowHostIPC: - description: AllowHostIPC determines if the policy allows host ipc in + description: allowHostIPC determines if the policy allows host ipc in the containers. type: boolean allowHostNetwork: - description: AllowHostNetwork determines if the policy allows the use + description: allowHostNetwork determines if the policy allows the use of HostNetwork in the pod spec. type: boolean allowHostPID: - description: AllowHostPID determines if the policy allows host pid in + description: allowHostPID determines if the policy allows host pid in the containers. type: boolean allowHostPorts: - description: AllowHostPorts determines if the policy allows host ports + description: allowHostPorts determines if the policy allows host ports in the containers. type: boolean allowPrivilegeEscalation: description: |- - AllowPrivilegeEscalation determines if a pod can request to allow + allowPrivilegeEscalation determines if a pod can request to allow privilege escalation. If unspecified, defaults to true. nullable: true type: boolean allowPrivilegedContainer: - description: AllowPrivilegedContainer determines if a container can request + description: allowPrivilegedContainer determines if a container can request to be run as privileged. type: boolean allowedCapabilities: description: |- - AllowedCapabilities is a list of capabilities that can be requested to add to the container. + 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 '*'. @@ -113,7 +113,7 @@ spec: x-kubernetes-list-type: atomic allowedFlexVolumes: description: |- - AllowedFlexVolumes is a whitelist of allowed Flexvolumes. Empty or nil indicates that all + 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. items: @@ -121,7 +121,7 @@ spec: allowed to be used. properties: driver: - description: Driver is the name of the Flexvolume driver. + description: driver is the name of the Flexvolume driver. type: string required: - driver @@ -131,7 +131,7 @@ spec: x-kubernetes-list-type: atomic allowedUnsafeSysctls: description: |- - AllowedUnsafeSysctls is a list of explicitly allowed unsafe sysctls, defaults to none. + 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. @@ -153,7 +153,7 @@ spec: type: string defaultAddCapabilities: description: |- - DefaultAddCapabilities is the default set of capabilities that will be added to the container + 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. items: @@ -164,13 +164,13 @@ spec: x-kubernetes-list-type: atomic defaultAllowPrivilegeEscalation: description: |- - DefaultAllowPrivilegeEscalation controls the default setting for whether a + defaultAllowPrivilegeEscalation controls the default setting for whether a process can gain more privileges than its parent process. nullable: true type: boolean forbiddenSysctls: description: |- - ForbiddenSysctls is a list of explicitly forbidden sysctls, defaults to none. + 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. @@ -183,30 +183,30 @@ spec: type: array x-kubernetes-list-type: atomic fsGroup: - description: FSGroup is the strategy that will dictate what fs group is + description: fsGroup is the strategy that will dictate what fs group is used by the SecurityContext. nullable: true properties: ranges: description: |- - Ranges are the allowed ranges of fs groups. If you would like to force a single + 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. items: description: IDRange provides a min/max of an allowed range of IDs. properties: max: - description: Max is the end of the range, inclusive. + description: max is the end of the range, inclusive. format: int64 type: integer min: - description: Min is the start of the range, inclusive. + description: min is the start of the range, inclusive. format: int64 type: integer type: object type: array x-kubernetes-list-type: atomic type: - description: Type is the strategy that will dictate what FSGroup is + description: type is the strategy that will dictate what FSGroup is used in the SecurityContext. type: string type: object @@ -230,7 +230,7 @@ spec: type: object priority: description: |- - Priority influences the sort order of SCCs when evaluating which SCCs to try first for + 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 @@ -241,7 +241,7 @@ spec: type: integer readOnlyRootFilesystem: description: |- - ReadOnlyRootFilesystem when set to true will force containers to run with a read only root file + 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 @@ -249,7 +249,7 @@ spec: type: boolean requiredDropCapabilities: description: |- - RequiredDropCapabilities are the capabilities that will be dropped from the container. These + requiredDropCapabilities are the capabilities that will be dropped from the container. These are required to be dropped and cannot be added. items: description: Capability represent POSIX capabilities type @@ -258,33 +258,33 @@ spec: type: array x-kubernetes-list-type: atomic runAsUser: - description: RunAsUser is the strategy that will dictate what RunAsUser + description: runAsUser is the strategy that will dictate what RunAsUser is used in the SecurityContext. nullable: true properties: type: - description: Type is the strategy that will dictate what RunAsUser + description: type is the strategy that will dictate what RunAsUser is used in the SecurityContext. type: string uid: description: |- - UID is the user id that containers must run as. Required for the MustRunAs strategy if not using + uid is the user id that containers must run as. Required for the MustRunAs strategy if not using namespace/service account allocated uids. format: int64 type: integer uidRangeMax: - description: UIDRangeMax defines the max value for a strategy that + description: uidRangeMax defines the max value for a strategy that allocates by range. format: int64 type: integer uidRangeMin: - description: UIDRangeMin defines the min value for a strategy that + description: uidRangeMin defines the min value for a strategy that allocates by range. format: int64 type: integer type: object seLinuxContext: - description: SELinuxContext is the strategy that will dictate what labels + description: seLinuxContext is the strategy that will dictate what labels will be set in the SecurityContext. nullable: true properties: @@ -309,12 +309,12 @@ spec: type: string type: object type: - description: Type is the strategy that will dictate what SELinux context + description: type is the strategy that will dictate what SELinux context is used in the SecurityContext. type: string type: object seccompProfiles: - description: "SeccompProfiles lists the allowed profiles that may be set + description: "seccompProfiles lists the allowed profiles that may be set for the pod or\ncontainer's seccomp annotations. An unset (nil) or empty value means that no profiles may\nbe specifid by the pod or container.\tThe wildcard '*' may be used to allow all profiles. When\nused to generate @@ -326,30 +326,30 @@ spec: type: array x-kubernetes-list-type: atomic supplementalGroups: - description: SupplementalGroups is the strategy that will dictate what + description: supplementalGroups is the strategy that will dictate what supplemental groups are used by the SecurityContext. nullable: true properties: ranges: description: |- - Ranges are the allowed ranges of supplemental groups. If you would like to force a single + 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. items: description: IDRange provides a min/max of an allowed range of IDs. properties: max: - description: Max is the end of the range, inclusive. + description: max is the end of the range, inclusive. format: int64 type: integer min: - description: Min is the start of the range, inclusive. + description: min is the start of the range, inclusive. format: int64 type: integer type: object type: array x-kubernetes-list-type: atomic type: - description: Type is the strategy that will dictate what supplemental + description: type is the strategy that will dictate what supplemental groups is used in the SecurityContext. type: string type: object @@ -375,7 +375,7 @@ spec: x-kubernetes-list-type: atomic volumes: description: |- - Volumes is a white list of allowed volume plugins. FSType corresponds directly with the field names + 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"]. items: diff --git a/security/v1/zz_generated.swagger_doc_generated.go b/security/v1/zz_generated.swagger_doc_generated.go index 2f242366a8c..29cddf7e647 100644 --- a/security/v1/zz_generated.swagger_doc_generated.go +++ b/security/v1/zz_generated.swagger_doc_generated.go @@ -13,7 +13,7 @@ package v1 // AUTO-GENERATED FUNCTIONS START HERE var map_AllowedFlexVolume = map[string]string{ "": "AllowedFlexVolume represents a single Flexvolume that is allowed to be used.", - "driver": "Driver is the name of the Flexvolume driver.", + "driver": "driver is the name of the Flexvolume driver.", } func (AllowedFlexVolume) SwaggerDoc() map[string]string { @@ -22,8 +22,8 @@ func (AllowedFlexVolume) SwaggerDoc() map[string]string { var map_FSGroupStrategyOptions = map[string]string{ "": "FSGroupStrategyOptions defines the strategy type and options used to create the strategy.", - "type": "Type is the strategy that will dictate what FSGroup is used in the SecurityContext.", - "ranges": "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": "type is the strategy that will dictate what FSGroup is used in the SecurityContext.", + "ranges": "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.", } func (FSGroupStrategyOptions) SwaggerDoc() map[string]string { @@ -32,8 +32,8 @@ func (FSGroupStrategyOptions) SwaggerDoc() map[string]string { var map_IDRange = map[string]string{ "": "IDRange provides a min/max of an allowed range of IDs.", - "min": "Min is the start of the range, inclusive.", - "max": "Max is the end of the range, inclusive.", + "min": "min is the start of the range, inclusive.", + "max": "max is the end of the range, inclusive.", } func (IDRange) SwaggerDoc() map[string]string { @@ -146,10 +146,10 @@ func (RangeAllocationList) SwaggerDoc() map[string]string { var map_RunAsUserStrategyOptions = map[string]string{ "": "RunAsUserStrategyOptions defines the strategy type and any options used to create the strategy.", - "type": "Type is the strategy that will dictate what RunAsUser is used in the SecurityContext.", - "uid": "UID is the user id that containers must run as. Required for the MustRunAs strategy if not using namespace/service account allocated uids.", - "uidRangeMin": "UIDRangeMin defines the min value for a strategy that allocates by range.", - "uidRangeMax": "UIDRangeMax defines the max value for a strategy that allocates by range.", + "type": "type is the strategy that will dictate what RunAsUser is used in the SecurityContext.", + "uid": "uid is the user id that containers must run as. Required for the MustRunAs strategy if not using namespace/service account allocated uids.", + "uidRangeMin": "uidRangeMin defines the min value for a strategy that allocates by range.", + "uidRangeMax": "uidRangeMax defines the max value for a strategy that allocates by range.", } func (RunAsUserStrategyOptions) SwaggerDoc() map[string]string { @@ -158,7 +158,7 @@ func (RunAsUserStrategyOptions) SwaggerDoc() map[string]string { var map_SELinuxContextStrategyOptions = map[string]string{ "": "SELinuxContextStrategyOptions defines the strategy type and any options used to create the strategy.", - "type": "Type is the strategy that will dictate what SELinux context is used in the SecurityContext.", + "type": "type is the strategy that will dictate what SELinux context is used in the SecurityContext.", "seLinuxOptions": "seLinuxOptions required to run as; required for MustRunAs", } @@ -169,31 +169,31 @@ func (SELinuxContextStrategyOptions) SwaggerDoc() map[string]string { var map_SecurityContextConstraints = map[string]string{ "": "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).", "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "priority": "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.", - "allowPrivilegedContainer": "AllowPrivilegedContainer determines if a container can request to be run as privileged.", - "defaultAddCapabilities": "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.", - "requiredDropCapabilities": "RequiredDropCapabilities are the capabilities that will be dropped from the container. These are required to be dropped and cannot be added.", - "allowedCapabilities": "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 '*'.", - "allowHostDirVolumePlugin": "AllowHostDirVolumePlugin determines if the policy allow containers to use the HostDir volume plugin", - "volumes": "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\"].", - "allowedFlexVolumes": "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.", - "allowHostNetwork": "AllowHostNetwork determines if the policy allows the use of HostNetwork in the pod spec.", - "allowHostPorts": "AllowHostPorts determines if the policy allows host ports in the containers.", - "allowHostPID": "AllowHostPID determines if the policy allows host pid in the containers.", - "allowHostIPC": "AllowHostIPC determines if the policy allows host ipc in the containers.", + "priority": "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.", + "allowPrivilegedContainer": "allowPrivilegedContainer determines if a container can request to be run as privileged.", + "defaultAddCapabilities": "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.", + "requiredDropCapabilities": "requiredDropCapabilities are the capabilities that will be dropped from the container. These are required to be dropped and cannot be added.", + "allowedCapabilities": "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 '*'.", + "allowHostDirVolumePlugin": "allowHostDirVolumePlugin determines if the policy allow containers to use the HostDir volume plugin", + "volumes": "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\"].", + "allowedFlexVolumes": "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.", + "allowHostNetwork": "allowHostNetwork determines if the policy allows the use of HostNetwork in the pod spec.", + "allowHostPorts": "allowHostPorts determines if the policy allows host ports in the containers.", + "allowHostPID": "allowHostPID determines if the policy allows host pid in the containers.", + "allowHostIPC": "allowHostIPC determines if the policy allows host ipc in the containers.", "userNamespaceLevel": "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\".", - "defaultAllowPrivilegeEscalation": "DefaultAllowPrivilegeEscalation controls the default setting for whether a process can gain more privileges than its parent process.", - "allowPrivilegeEscalation": "AllowPrivilegeEscalation determines if a pod can request to allow privilege escalation. If unspecified, defaults to true.", - "seLinuxContext": "SELinuxContext is the strategy that will dictate what labels will be set in the SecurityContext.", - "runAsUser": "RunAsUser is the strategy that will dictate what RunAsUser is used in the SecurityContext.", - "supplementalGroups": "SupplementalGroups is the strategy that will dictate what supplemental groups are used by the SecurityContext.", - "fsGroup": "FSGroup is the strategy that will dictate what fs group is used by the SecurityContext.", - "readOnlyRootFilesystem": "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.", + "defaultAllowPrivilegeEscalation": "defaultAllowPrivilegeEscalation controls the default setting for whether a process can gain more privileges than its parent process.", + "allowPrivilegeEscalation": "allowPrivilegeEscalation determines if a pod can request to allow privilege escalation. If unspecified, defaults to true.", + "seLinuxContext": "seLinuxContext is the strategy that will dictate what labels will be set in the SecurityContext.", + "runAsUser": "runAsUser is the strategy that will dictate what RunAsUser is used in the SecurityContext.", + "supplementalGroups": "supplementalGroups is the strategy that will dictate what supplemental groups are used by the SecurityContext.", + "fsGroup": "fsGroup is the strategy that will dictate what fs group is used by the SecurityContext.", + "readOnlyRootFilesystem": "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.", "users": "The users who have permissions to use this security context constraints", "groups": "The groups that have permission to use this security context constraints", - "seccompProfiles": "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.", - "allowedUnsafeSysctls": "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.", - "forbiddenSysctls": "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.", + "seccompProfiles": "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.", + "allowedUnsafeSysctls": "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.", + "forbiddenSysctls": "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.", } func (SecurityContextConstraints) SwaggerDoc() map[string]string { @@ -221,8 +221,8 @@ func (ServiceAccountPodSecurityPolicyReviewStatus) SwaggerDoc() map[string]strin var map_SupplementalGroupsStrategyOptions = map[string]string{ "": "SupplementalGroupsStrategyOptions defines the strategy type and options used to create the strategy.", - "type": "Type is the strategy that will dictate what supplemental groups is used in the SecurityContext.", - "ranges": "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": "type is the strategy that will dictate what supplemental groups is used in the SecurityContext.", + "ranges": "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.", } func (SupplementalGroupsStrategyOptions) SwaggerDoc() map[string]string { diff --git a/servicecertsigner/v1alpha1/types.go b/servicecertsigner/v1alpha1/types.go index ebd8d75efc8..3ad1c560fd7 100644 --- a/servicecertsigner/v1alpha1/types.go +++ b/servicecertsigner/v1alpha1/types.go @@ -48,6 +48,6 @@ type ServiceCertSignerOperatorConfigList struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ListMeta `json:"metadata,omitempty"` - // Items contains the items + // items contains the items Items []ServiceCertSignerOperatorConfig `json:"items"` } diff --git a/servicecertsigner/v1alpha1/zz_generated.swagger_doc_generated.go b/servicecertsigner/v1alpha1/zz_generated.swagger_doc_generated.go index 13b3b736440..5e341b1dad5 100644 --- a/servicecertsigner/v1alpha1/zz_generated.swagger_doc_generated.go +++ b/servicecertsigner/v1alpha1/zz_generated.swagger_doc_generated.go @@ -23,7 +23,7 @@ func (ServiceCertSignerOperatorConfig) SwaggerDoc() map[string]string { var map_ServiceCertSignerOperatorConfigList = map[string]string{ "": "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.", "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "items": "Items contains the items", + "items": "items contains the items", } func (ServiceCertSignerOperatorConfigList) SwaggerDoc() map[string]string { diff --git a/sharedresource/v1alpha1/types_shared_configmap.go b/sharedresource/v1alpha1/types_shared_configmap.go index 1eea47d02d4..3b6e6be3745 100644 --- a/sharedresource/v1alpha1/types_shared_configmap.go +++ b/sharedresource/v1alpha1/types_shared_configmap.go @@ -11,19 +11,20 @@ import metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" // "csi.sharedresource.openshift.io" CSI driver and a reference to the SharedConfigMap in the volume attributes: // // spec: -// volumes: -// - name: shared-configmap -// csi: -// driver: csi.sharedresource.openshift.io -// volumeAttributes: -// sharedConfigMap: my-share +// +// volumes: +// - name: shared-configmap +// csi: +// driver: csi.sharedresource.openshift.io +// volumeAttributes: +// sharedConfigMap: my-share // // For 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. // -// `oc create role shared-resource-my-share --verb=use --resource=sharedconfigmaps.sharedresource.openshift.io --resource-name=my-share` -// `oc create rolebinding shared-resource-my-share --role=shared-resource-my-share --serviceaccount=my-namespace:default` +// `oc create role shared-resource-my-share --verb=use --resource=sharedconfigmaps.sharedresource.openshift.io --resource-name=my-share` +// `oc create rolebinding shared-resource-my-share --role=shared-resource-my-share --serviceaccount=my-namespace:default` // // Shared resource objects, in this case ConfigMaps, have default permissions of list, get, and watch for system authenticated users. // @@ -45,7 +46,7 @@ type SharedConfigMap struct { metav1.ObjectMeta `json:"metadata,omitempty"` // spec is the specification of the desired shared configmap - // +kubebuilder:validation:Required + // +required Spec SharedConfigMapSpec `json:"spec,omitempty"` // status is the observed status of the shared configmap @@ -72,10 +73,10 @@ type SharedConfigMapList struct { // SharedConfigMapReference contains information about which ConfigMap to share type SharedConfigMapReference struct { // name represents the name of the ConfigMap that is being referenced. - // +kubebuilder:validation:Required + // +required Name string `json:"name"` // namespace represents the namespace where the referenced ConfigMap is located. - // +kubebuilder:validation:Required + // +required Namespace string `json:"namespace"` } @@ -83,7 +84,7 @@ type SharedConfigMapReference struct { // +k8s:openapi-gen=true type SharedConfigMapSpec struct { //configMapRef is a reference to the ConfigMap to share - // +kubebuilder:validation:Required + // +required ConfigMapRef SharedConfigMapReference `json:"configMapRef"` // description is a user readable explanation of what the backing resource provides. Description string `json:"description,omitempty"` diff --git a/sharedresource/v1alpha1/types_shared_secret.go b/sharedresource/v1alpha1/types_shared_secret.go index 654106bce69..3ea9260f0ce 100644 --- a/sharedresource/v1alpha1/types_shared_secret.go +++ b/sharedresource/v1alpha1/types_shared_secret.go @@ -11,19 +11,20 @@ import metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" // "csi.sharedresource.openshift.io" CSI driver and a reference to the SharedSecret in the volume attributes: // // spec: -// volumes: -// - name: shared-secret -// csi: -// driver: csi.sharedresource.openshift.io -// volumeAttributes: -// sharedSecret: my-share +// +// volumes: +// - name: shared-secret +// csi: +// driver: csi.sharedresource.openshift.io +// volumeAttributes: +// sharedSecret: my-share // // For 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. // -// `oc create role shared-resource-my-share --verb=use --resource=sharedsecrets.sharedresource.openshift.io --resource-name=my-share` -// `oc create rolebinding shared-resource-my-share --role=shared-resource-my-share --serviceaccount=my-namespace:default` +// `oc create role shared-resource-my-share --verb=use --resource=sharedsecrets.sharedresource.openshift.io --resource-name=my-share` +// `oc create rolebinding shared-resource-my-share --role=shared-resource-my-share --serviceaccount=my-namespace:default` // // Shared resource objects, in this case Secrets, have default permissions of list, get, and watch for system authenticated users. // @@ -44,7 +45,7 @@ type SharedSecret struct { metav1.ObjectMeta `json:"metadata,omitempty"` // spec is the specification of the desired shared secret - // +kubebuilder:validation:Required + // +required Spec SharedSecretSpec `json:"spec,omitempty"` // status is the observed status of the shared secret @@ -71,10 +72,10 @@ type SharedSecretList struct { // SharedSecretReference contains information about which Secret to share type SharedSecretReference struct { // name represents the name of the Secret that is being referenced. - // +kubebuilder:validation:Required + // +required Name string `json:"name"` // namespace represents the namespace where the referenced Secret is located. - // +kubebuilder:validation:Required + // +required Namespace string `json:"namespace"` } @@ -82,7 +83,7 @@ type SharedSecretReference struct { // +k8s:openapi-gen=true type SharedSecretSpec struct { // secretRef is a reference to the Secret to share - // +kubebuilder:validation:Required + // +required SecretRef SharedSecretReference `json:"secretRef"` // description is a user readable explanation of what the backing resource provides. Description string `json:"description,omitempty"` diff --git a/sharedresource/v1alpha1/zz_generated.crd-manifests/sharedconfigmaps.crd.yaml b/sharedresource/v1alpha1/zz_generated.crd-manifests/sharedconfigmaps.crd.yaml index a33cd208c97..03f7692f9e3 100644 --- a/sharedresource/v1alpha1/zz_generated.crd-manifests/sharedconfigmaps.crd.yaml +++ b/sharedresource/v1alpha1/zz_generated.crd-manifests/sharedconfigmaps.crd.yaml @@ -21,30 +21,24 @@ spec: - name: v1alpha1 schema: openAPIV3Schema: - 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: - - spec: - volumes: - - name: shared-configmap - csi: - driver: csi.sharedresource.openshift.io - volumeAttributes: - sharedConfigMap: my-share - - For 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. - - `oc create role shared-resource-my-share --verb=use --resource=sharedconfigmaps.sharedresource.openshift.io --resource-name=my-share` - `oc create rolebinding shared-resource-my-share --role=shared-resource-my-share --serviceaccount=my-namespace:default` - - Shared resource objects, in this case ConfigMaps, have default permissions of list, get, and watch for system authenticated users. - - 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. - These capabilities should not be used by applications needing long term support. + description: "SharedConfigMap allows a ConfigMap to be shared across namespaces.\nPods + can mount the shared ConfigMap by adding a CSI volume to the pod specification + using the\n\"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\nwithin its namespace with an appropriate + Role and RoleBinding. For compactness, here are example `oc` invocations + for creating\nsuch 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.\nThese capabilities + should not be used by applications needing long term support." properties: apiVersion: description: |- diff --git a/sharedresource/v1alpha1/zz_generated.crd-manifests/sharedsecrets.crd.yaml b/sharedresource/v1alpha1/zz_generated.crd-manifests/sharedsecrets.crd.yaml index bb3ea7c5e14..01ba1ed540e 100644 --- a/sharedresource/v1alpha1/zz_generated.crd-manifests/sharedsecrets.crd.yaml +++ b/sharedresource/v1alpha1/zz_generated.crd-manifests/sharedsecrets.crd.yaml @@ -21,30 +21,24 @@ spec: - name: v1alpha1 schema: openAPIV3Schema: - 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: - - spec: - volumes: - - name: shared-secret - csi: - driver: csi.sharedresource.openshift.io - volumeAttributes: - sharedSecret: my-share - - For 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. - - `oc create role shared-resource-my-share --verb=use --resource=sharedsecrets.sharedresource.openshift.io --resource-name=my-share` - `oc create rolebinding shared-resource-my-share --role=shared-resource-my-share --serviceaccount=my-namespace:default` - - Shared resource objects, in this case Secrets, have default permissions of list, get, and watch for system authenticated users. - - 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. - These capabilities should not be used by applications needing long term support. + description: "SharedSecret allows a Secret to be shared across namespaces.\nPods + can mount the shared Secret by adding a CSI volume to the pod specification + using the\n\"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\nwithin its namespace with an appropriate + Role and RoleBinding. For compactness, here are example `oc` invocations + for creating\nsuch 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.\nThese capabilities + should not be used by applications needing long term support." properties: apiVersion: description: |- diff --git a/sharedresource/v1alpha1/zz_generated.featuregated-crd-manifests/sharedconfigmaps.sharedresource.openshift.io/AAA_ungated.yaml b/sharedresource/v1alpha1/zz_generated.featuregated-crd-manifests/sharedconfigmaps.sharedresource.openshift.io/AAA_ungated.yaml index fba2665808f..3e3ac3a7e30 100644 --- a/sharedresource/v1alpha1/zz_generated.featuregated-crd-manifests/sharedconfigmaps.sharedresource.openshift.io/AAA_ungated.yaml +++ b/sharedresource/v1alpha1/zz_generated.featuregated-crd-manifests/sharedconfigmaps.sharedresource.openshift.io/AAA_ungated.yaml @@ -19,30 +19,24 @@ spec: - name: v1alpha1 schema: openAPIV3Schema: - 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: - - spec: - volumes: - - name: shared-configmap - csi: - driver: csi.sharedresource.openshift.io - volumeAttributes: - sharedConfigMap: my-share - - For 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. - - `oc create role shared-resource-my-share --verb=use --resource=sharedconfigmaps.sharedresource.openshift.io --resource-name=my-share` - `oc create rolebinding shared-resource-my-share --role=shared-resource-my-share --serviceaccount=my-namespace:default` - - Shared resource objects, in this case ConfigMaps, have default permissions of list, get, and watch for system authenticated users. - - 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. - These capabilities should not be used by applications needing long term support. + description: "SharedConfigMap allows a ConfigMap to be shared across namespaces.\nPods + can mount the shared ConfigMap by adding a CSI volume to the pod specification + using the\n\"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\nwithin its namespace with an appropriate + Role and RoleBinding. For compactness, here are example `oc` invocations + for creating\nsuch 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.\nThese capabilities + should not be used by applications needing long term support." properties: apiVersion: description: |- diff --git a/sharedresource/v1alpha1/zz_generated.featuregated-crd-manifests/sharedsecrets.sharedresource.openshift.io/AAA_ungated.yaml b/sharedresource/v1alpha1/zz_generated.featuregated-crd-manifests/sharedsecrets.sharedresource.openshift.io/AAA_ungated.yaml index 5501264dc7b..bc7b20dc1bb 100644 --- a/sharedresource/v1alpha1/zz_generated.featuregated-crd-manifests/sharedsecrets.sharedresource.openshift.io/AAA_ungated.yaml +++ b/sharedresource/v1alpha1/zz_generated.featuregated-crd-manifests/sharedsecrets.sharedresource.openshift.io/AAA_ungated.yaml @@ -19,30 +19,24 @@ spec: - name: v1alpha1 schema: openAPIV3Schema: - 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: - - spec: - volumes: - - name: shared-secret - csi: - driver: csi.sharedresource.openshift.io - volumeAttributes: - sharedSecret: my-share - - For 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. - - `oc create role shared-resource-my-share --verb=use --resource=sharedsecrets.sharedresource.openshift.io --resource-name=my-share` - `oc create rolebinding shared-resource-my-share --role=shared-resource-my-share --serviceaccount=my-namespace:default` - - Shared resource objects, in this case Secrets, have default permissions of list, get, and watch for system authenticated users. - - 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. - These capabilities should not be used by applications needing long term support. + description: "SharedSecret allows a Secret to be shared across namespaces.\nPods + can mount the shared Secret by adding a CSI volume to the pod specification + using the\n\"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\nwithin its namespace with an appropriate + Role and RoleBinding. For compactness, here are example `oc` invocations + for creating\nsuch 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.\nThese capabilities + should not be used by applications needing long term support." properties: apiVersion: description: |- diff --git a/sharedresource/v1alpha1/zz_generated.swagger_doc_generated.go b/sharedresource/v1alpha1/zz_generated.swagger_doc_generated.go index f432d63f77c..ea6334d147c 100644 --- a/sharedresource/v1alpha1/zz_generated.swagger_doc_generated.go +++ b/sharedresource/v1alpha1/zz_generated.swagger_doc_generated.go @@ -12,7 +12,7 @@ package v1alpha1 // AUTO-GENERATED FUNCTIONS START HERE var map_SharedConfigMap = map[string]string{ - "": "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 volumes:\n - name: shared-configmap\n csi:\n driver: csi.sharedresource.openshift.io\n volumeAttributes:\n 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 `oc create role shared-resource-my-share --verb=use --resource=sharedconfigmaps.sharedresource.openshift.io --resource-name=my-share`\n `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.", + "": "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.", "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", "spec": "spec is the specification of the desired shared configmap", "status": "status is the observed status of the shared configmap", @@ -61,7 +61,7 @@ func (SharedConfigMapStatus) SwaggerDoc() map[string]string { } var map_SharedSecret = map[string]string{ - "": "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 volumes:\n - name: shared-secret\n csi:\n driver: csi.sharedresource.openshift.io\n volumeAttributes:\n 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 `oc create role shared-resource-my-share --verb=use --resource=sharedsecrets.sharedresource.openshift.io --resource-name=my-share`\n `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.", + "": "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.", "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", "spec": "spec is the specification of the desired shared secret", "status": "status is the observed status of the shared secret", diff --git a/template/v1/generated.proto b/template/v1/generated.proto index 5ff4d7b1d61..8f27eb48a04 100644 --- a/template/v1/generated.proto +++ b/template/v1/generated.proto @@ -42,7 +42,7 @@ message BrokerTemplateInstanceList { // BrokerTemplateInstanceSpec describes the state of a BrokerTemplateInstance. message BrokerTemplateInstanceSpec { - // templateinstance is a reference to a TemplateInstance object residing + // templateInstance is a reference to a TemplateInstance object residing // in a namespace. optional .k8s.io.api.core.v1.ObjectReference templateInstance = 1; @@ -50,7 +50,7 @@ message BrokerTemplateInstanceSpec { // containing the necessary template parameters. optional .k8s.io.api.core.v1.ObjectReference secret = 2; - // bindingids is a list of 'binding_id's provided during successive bind + // bindingIDs is a list of 'binding_id's provided during successive bind // calls to the template service broker. repeated string bindingIDs = 3; } @@ -67,17 +67,17 @@ message ExtraValue { // Parameter defines a name/value variable that is to be processed during // the Template to Config transformation. message Parameter { - // Name must be set and it can be referenced in Template + // name must be set and it can be referenced in Template // Items using ${PARAMETER_NAME}. Required. optional string name = 1; // Optional: The name that will show in UI instead of parameter 'Name' optional string displayName = 2; - // Description of a parameter. Optional. + // description of a parameter. Optional. optional string description = 3; - // Value holds the Parameter data. If specified, the generator will be + // 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. optional string value = 4; @@ -101,7 +101,7 @@ message Parameter { // "[a-zA-Z0-9]{8}" | "hW4yQU5i" optional string generate = 5; - // From is an input value for the generator. Optional. + // from is an input value for the generator. Optional. optional string from = 6; // Optional: Indicates the parameter must have a value. Defaults to false. @@ -164,21 +164,21 @@ message TemplateInstance { // TemplateInstanceCondition contains condition information for a // TemplateInstance. message TemplateInstanceCondition { - // Type of the condition, currently Ready or InstantiateFailure. + // type of the condition, currently Ready or InstantiateFailure. optional string type = 1; - // Status of the condition, one of True, False or Unknown. + // status of the condition, one of True, False or Unknown. optional string status = 2; - // LastTransitionTime is the last time a condition status transitioned from + // lastTransitionTime is the last time a condition status transitioned from // one state to another. optional .k8s.io.apimachinery.pkg.apis.meta.v1.Time lastTransitionTime = 3; - // Reason is a brief machine readable explanation for the condition's last + // reason is a brief machine readable explanation for the condition's last // transition. optional string reason = 4; - // Message is a human readable description of the details of the last + // message is a human readable description of the details of the last // transition, complementing reason. optional string message = 5; } @@ -243,7 +243,7 @@ message TemplateInstanceStatus { // TemplateInstance's current state. repeated TemplateInstanceCondition conditions = 1; - // Objects references the objects created by the TemplateInstance. + // objects references the objects created by the TemplateInstance. repeated TemplateInstanceObject objects = 2; } @@ -256,7 +256,7 @@ message TemplateList { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata optional .k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1; - // Items is a list of templates + // items is a list of templates repeated Template items = 2; } diff --git a/template/v1/types.go b/template/v1/types.go index 9d95912b28e..5510b0f90b6 100644 --- a/template/v1/types.go +++ b/template/v1/types.go @@ -61,24 +61,24 @@ type TemplateList struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` - // Items is a list of templates + // items is a list of templates Items []Template `json:"items" protobuf:"bytes,2,rep,name=items"` } // Parameter defines a name/value variable that is to be processed during // the Template to Config transformation. type Parameter struct { - // Name must be set and it can be referenced in Template + // name must be set and it can be referenced in Template // Items using ${PARAMETER_NAME}. Required. Name string `json:"name" protobuf:"bytes,1,opt,name=name"` // Optional: The name that will show in UI instead of parameter 'Name' DisplayName string `json:"displayName,omitempty" protobuf:"bytes,2,opt,name=displayName"` - // Description of a parameter. Optional. + // description of a parameter. Optional. Description string `json:"description,omitempty" protobuf:"bytes,3,opt,name=description"` - // Value holds the Parameter data. If specified, the generator will be + // 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. Value string `json:"value,omitempty" protobuf:"bytes,4,opt,name=value"` @@ -103,7 +103,7 @@ type Parameter struct { // Generate string `json:"generate,omitempty" protobuf:"bytes,5,opt,name=generate"` - // From is an input value for the generator. Optional. + // from is an input value for the generator. Optional. From string `json:"from,omitempty" protobuf:"bytes,6,opt,name=from"` // Optional: Indicates the parameter must have a value. Defaults to false. @@ -181,24 +181,24 @@ type TemplateInstanceStatus struct { // TemplateInstance's current state. Conditions []TemplateInstanceCondition `json:"conditions,omitempty" protobuf:"bytes,1,rep,name=conditions"` - // Objects references the objects created by the TemplateInstance. + // objects references the objects created by the TemplateInstance. Objects []TemplateInstanceObject `json:"objects,omitempty" protobuf:"bytes,2,rep,name=objects"` } // TemplateInstanceCondition contains condition information for a // TemplateInstance. type TemplateInstanceCondition struct { - // Type of the condition, currently Ready or InstantiateFailure. + // type of the condition, currently Ready or InstantiateFailure. Type TemplateInstanceConditionType `json:"type" protobuf:"bytes,1,opt,name=type,casttype=TemplateInstanceConditionType"` - // Status of the condition, one of True, False or Unknown. + // status of the condition, one of True, False or Unknown. Status corev1.ConditionStatus `json:"status" protobuf:"bytes,2,opt,name=status"` - // LastTransitionTime is the last time a condition status transitioned from + // lastTransitionTime is the last time a condition status transitioned from // one state to another. LastTransitionTime metav1.Time `json:"lastTransitionTime" protobuf:"bytes,3,opt,name=lastTransitionTime"` - // Reason is a brief machine readable explanation for the condition's last + // reason is a brief machine readable explanation for the condition's last // transition. Reason string `json:"reason" protobuf:"bytes,4,opt,name=reason"` - // Message is a human readable description of the details of the last + // message is a human readable description of the details of the last // transition, complementing reason. Message string `json:"message" protobuf:"bytes,5,opt,name=message"` } @@ -263,7 +263,7 @@ type BrokerTemplateInstance struct { // BrokerTemplateInstanceSpec describes the state of a BrokerTemplateInstance. type BrokerTemplateInstanceSpec struct { - // templateinstance is a reference to a TemplateInstance object residing + // templateInstance is a reference to a TemplateInstance object residing // in a namespace. TemplateInstance corev1.ObjectReference `json:"templateInstance" protobuf:"bytes,1,opt,name=templateInstance"` @@ -271,7 +271,7 @@ type BrokerTemplateInstanceSpec struct { // containing the necessary template parameters. Secret corev1.ObjectReference `json:"secret" protobuf:"bytes,2,opt,name=secret"` - // bindingids is a list of 'binding_id's provided during successive bind + // bindingIDs is a list of 'binding_id's provided during successive bind // calls to the template service broker. BindingIDs []string `json:"bindingIDs,omitempty" protobuf:"bytes,3,rep,name=bindingIDs"` } diff --git a/template/v1/zz_generated.swagger_doc_generated.go b/template/v1/zz_generated.swagger_doc_generated.go index 8ed3822c8d5..761390d02f7 100644 --- a/template/v1/zz_generated.swagger_doc_generated.go +++ b/template/v1/zz_generated.swagger_doc_generated.go @@ -33,9 +33,9 @@ func (BrokerTemplateInstanceList) SwaggerDoc() map[string]string { var map_BrokerTemplateInstanceSpec = map[string]string{ "": "BrokerTemplateInstanceSpec describes the state of a BrokerTemplateInstance.", - "templateInstance": "templateinstance is a reference to a TemplateInstance object residing in a namespace.", + "templateInstance": "templateInstance is a reference to a TemplateInstance object residing in a namespace.", "secret": "secret is a reference to a Secret object residing in a namespace, containing the necessary template parameters.", - "bindingIDs": "bindingids is a list of 'binding_id's provided during successive bind calls to the template service broker.", + "bindingIDs": "bindingIDs is a list of 'binding_id's provided during successive bind calls to the template service broker.", } func (BrokerTemplateInstanceSpec) SwaggerDoc() map[string]string { @@ -44,12 +44,12 @@ func (BrokerTemplateInstanceSpec) SwaggerDoc() map[string]string { var map_Parameter = map[string]string{ "": "Parameter defines a name/value variable that is to be processed during the Template to Config transformation.", - "name": "Name must be set and it can be referenced in Template Items using ${PARAMETER_NAME}. Required.", + "name": "name must be set and it can be referenced in Template Items using ${PARAMETER_NAME}. Required.", "displayName": "Optional: The name that will show in UI instead of parameter 'Name'", - "description": "Description of a parameter. Optional.", - "value": "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.", + "description": "description of a parameter. Optional.", + "value": "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.", "generate": "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", - "from": "From is an input value for the generator. Optional.", + "from": "from is an input value for the generator. Optional.", "required": "Optional: Indicates the parameter must have a value. Defaults to false.", } @@ -83,11 +83,11 @@ func (TemplateInstance) SwaggerDoc() map[string]string { var map_TemplateInstanceCondition = map[string]string{ "": "TemplateInstanceCondition contains condition information for a TemplateInstance.", - "type": "Type of the condition, currently Ready or InstantiateFailure.", - "status": "Status of the condition, one of True, False or Unknown.", - "lastTransitionTime": "LastTransitionTime is the last time a condition status transitioned from one state to another.", - "reason": "Reason is a brief machine readable explanation for the condition's last transition.", - "message": "Message is a human readable description of the details of the last transition, complementing reason.", + "type": "type of the condition, currently Ready or InstantiateFailure.", + "status": "status of the condition, one of True, False or Unknown.", + "lastTransitionTime": "lastTransitionTime is the last time a condition status transitioned from one state to another.", + "reason": "reason is a brief machine readable explanation for the condition's last transition.", + "message": "message is a human readable description of the details of the last transition, complementing reason.", } func (TemplateInstanceCondition) SwaggerDoc() map[string]string { @@ -139,7 +139,7 @@ func (TemplateInstanceSpec) SwaggerDoc() map[string]string { var map_TemplateInstanceStatus = map[string]string{ "": "TemplateInstanceStatus describes the current state of a TemplateInstance.", "conditions": "conditions represent the latest available observations of a TemplateInstance's current state.", - "objects": "Objects references the objects created by the TemplateInstance.", + "objects": "objects references the objects created by the TemplateInstance.", } func (TemplateInstanceStatus) SwaggerDoc() map[string]string { @@ -149,7 +149,7 @@ func (TemplateInstanceStatus) SwaggerDoc() map[string]string { var map_TemplateList = map[string]string{ "": "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).", "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "items": "Items is a list of templates", + "items": "items is a list of templates", } func (TemplateList) SwaggerDoc() map[string]string { diff --git a/unidling/v1alpha1/types.go b/unidling/v1alpha1/types.go index d6ac1cc2e06..0fba167f6e5 100644 --- a/unidling/v1alpha1/types.go +++ b/unidling/v1alpha1/types.go @@ -32,12 +32,12 @@ type RecordedScaleReference struct { // namespace in the specified group. It is similar to // autoscaling.CrossVersionObjectReference. type CrossGroupObjectReference struct { - // Kind of the referent; More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds" + // kind of the referent; More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds" Kind string `json:"kind" protobuf:"bytes,1,opt,name=kind"` - // Name of the referent; More info: http://releases.k8s.io/release-1.3/docs/user-guide/identifiers.md#names + // name of the referent; More info: http://releases.k8s.io/release-1.3/docs/user-guide/identifiers.md#names Name string `json:"name" protobuf:"bytes,2,opt,name=name"` // API version of the referent (deprecated, prefer usng Group instead) APIVersion string `json:"apiVersion,omitempty" protobuf:"bytes,3,opt,name=apiVersion"` - // Group of the referent + // group of the referent Group string `json:"group,omitempty" protobuf:"bytes,3,opt,name=group"` } diff --git a/unidling/v1alpha1/zz_generated.swagger_doc_generated.go b/unidling/v1alpha1/zz_generated.swagger_doc_generated.go index 5eabb4abb7e..9b3b8ac25e5 100644 --- a/unidling/v1alpha1/zz_generated.swagger_doc_generated.go +++ b/unidling/v1alpha1/zz_generated.swagger_doc_generated.go @@ -13,10 +13,10 @@ package v1alpha1 // AUTO-GENERATED FUNCTIONS START HERE var map_CrossGroupObjectReference = map[string]string{ "": "CrossGroupObjectReference is a reference to an object in the same namespace in the specified group. It is similar to autoscaling.CrossVersionObjectReference.", - "kind": "Kind of the referent; More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds\"", - "name": "Name of the referent; More info: http://releases.k8s.io/release-1.3/docs/user-guide/identifiers.md#names", + "kind": "kind of the referent; More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds\"", + "name": "name of the referent; More info: http://releases.k8s.io/release-1.3/docs/user-guide/identifiers.md#names", "apiVersion": "API version of the referent (deprecated, prefer usng Group instead)", - "group": "Group of the referent", + "group": "group of the referent", } func (CrossGroupObjectReference) SwaggerDoc() map[string]string { diff --git a/user/v1/generated.proto b/user/v1/generated.proto index c1c2b8156bb..f07b446ad45 100644 --- a/user/v1/generated.proto +++ b/user/v1/generated.proto @@ -21,7 +21,7 @@ message Group { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata optional .k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1; - // Users is the list of users in this group. + // users is the list of users in this group. optional OptionalNames users = 2; } @@ -34,7 +34,7 @@ message GroupList { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata optional .k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1; - // Items is the list of groups + // items is the list of groups repeated Group items = 2; } @@ -51,17 +51,17 @@ message Identity { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata optional .k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1; - // ProviderName is the source of identity information + // providerName is the source of identity information optional string providerName = 2; - // ProviderUserName uniquely represents this identity in the scope of the provider + // providerUserName uniquely represents this identity in the scope of the provider optional string providerUserName = 3; - // User is a reference to the user this identity is associated with + // user is a reference to the user this identity is associated with // Both Name and UID must be set optional .k8s.io.api.core.v1.ObjectReference user = 4; - // Extra holds extra information about this identity + // extra holds extra information about this identity map extra = 5; } @@ -74,7 +74,7 @@ message IdentityList { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata optional .k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1; - // Items is the list of identities + // items is the list of identities repeated Identity items = 2; } @@ -100,14 +100,14 @@ message User { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata optional .k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1; - // FullName is the full name of user + // fullName is the full name of user optional string fullName = 2; - // Identities are the identities associated with this user + // identities are the identities associated with this user // +optional repeated string identities = 3; - // Groups specifies group names this user is a member of. + // 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. repeated string groups = 4; @@ -122,10 +122,10 @@ message UserIdentityMapping { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata optional .k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1; - // Identity is a reference to an identity + // identity is a reference to an identity optional .k8s.io.api.core.v1.ObjectReference identity = 2; - // User is a reference to a user + // user is a reference to a user optional .k8s.io.api.core.v1.ObjectReference user = 3; } @@ -138,7 +138,7 @@ message UserList { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata optional .k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1; - // Items is the list of users + // items is the list of users repeated User items = 2; } diff --git a/user/v1/types.go b/user/v1/types.go index 7014bbfac7c..64ae8c8300b 100644 --- a/user/v1/types.go +++ b/user/v1/types.go @@ -26,14 +26,14 @@ type User struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` - // FullName is the full name of user + // fullName is the full name of user FullName string `json:"fullName,omitempty" protobuf:"bytes,2,opt,name=fullName"` - // Identities are the identities associated with this user + // identities are the identities associated with this user // +optional Identities []string `json:"identities,omitempty" protobuf:"bytes,3,rep,name=identities"` - // Groups specifies group names this user is a member of. + // 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. Groups []string `json:"groups" protobuf:"bytes,4,rep,name=groups"` @@ -52,7 +52,7 @@ type UserList struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` - // Items is the list of users + // items is the list of users Items []User `json:"items" protobuf:"bytes,2,rep,name=items"` } @@ -75,17 +75,17 @@ type Identity struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` - // ProviderName is the source of identity information + // providerName is the source of identity information ProviderName string `json:"providerName" protobuf:"bytes,2,opt,name=providerName"` - // ProviderUserName uniquely represents this identity in the scope of the provider + // providerUserName uniquely represents this identity in the scope of the provider ProviderUserName string `json:"providerUserName" protobuf:"bytes,3,opt,name=providerUserName"` - // User is a reference to the user this identity is associated with + // user is a reference to the user this identity is associated with // Both Name and UID must be set User corev1.ObjectReference `json:"user" protobuf:"bytes,4,opt,name=user"` - // Extra holds extra information about this identity + // extra holds extra information about this identity Extra map[string]string `json:"extra,omitempty" protobuf:"bytes,5,rep,name=extra"` } @@ -102,7 +102,7 @@ type IdentityList struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` - // Items is the list of identities + // items is the list of identities Items []Identity `json:"items" protobuf:"bytes,2,rep,name=items"` } @@ -122,9 +122,9 @@ type UserIdentityMapping struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` - // Identity is a reference to an identity + // identity is a reference to an identity Identity corev1.ObjectReference `json:"identity,omitempty" protobuf:"bytes,2,opt,name=identity"` - // User is a reference to a user + // user is a reference to a user User corev1.ObjectReference `json:"user,omitempty" protobuf:"bytes,3,opt,name=user"` } @@ -152,7 +152,7 @@ type Group struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` - // Users is the list of users in this group. + // users is the list of users in this group. Users OptionalNames `json:"users" protobuf:"bytes,2,rep,name=users"` } @@ -169,6 +169,6 @@ type GroupList struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` - // Items is the list of groups + // items is the list of groups Items []Group `json:"items" protobuf:"bytes,2,rep,name=items"` } diff --git a/user/v1/zz_generated.swagger_doc_generated.go b/user/v1/zz_generated.swagger_doc_generated.go index 5844723a72c..d85e7dfc58a 100644 --- a/user/v1/zz_generated.swagger_doc_generated.go +++ b/user/v1/zz_generated.swagger_doc_generated.go @@ -14,7 +14,7 @@ package v1 var map_Group = map[string]string{ "": "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).", "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "users": "Users is the list of users in this group.", + "users": "users is the list of users in this group.", } func (Group) SwaggerDoc() map[string]string { @@ -24,7 +24,7 @@ func (Group) SwaggerDoc() map[string]string { var map_GroupList = map[string]string{ "": "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).", "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "items": "Items is the list of groups", + "items": "items is the list of groups", } func (GroupList) SwaggerDoc() map[string]string { @@ -34,10 +34,10 @@ func (GroupList) SwaggerDoc() map[string]string { var map_Identity = map[string]string{ "": "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).", "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "providerName": "ProviderName is the source of identity information", - "providerUserName": "ProviderUserName uniquely represents this identity in the scope of the provider", - "user": "User is a reference to the user this identity is associated with Both Name and UID must be set", - "extra": "Extra holds extra information about this identity", + "providerName": "providerName is the source of identity information", + "providerUserName": "providerUserName uniquely represents this identity in the scope of the provider", + "user": "user is a reference to the user this identity is associated with Both Name and UID must be set", + "extra": "extra holds extra information about this identity", } func (Identity) SwaggerDoc() map[string]string { @@ -47,7 +47,7 @@ func (Identity) SwaggerDoc() map[string]string { var map_IdentityList = map[string]string{ "": "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).", "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "items": "Items is the list of identities", + "items": "items is the list of identities", } func (IdentityList) SwaggerDoc() map[string]string { @@ -57,9 +57,9 @@ func (IdentityList) SwaggerDoc() map[string]string { var map_User = map[string]string{ "": "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).", "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "fullName": "FullName is the full name of user", - "identities": "Identities are the identities associated with this user", - "groups": "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.", + "fullName": "fullName is the full name of user", + "identities": "identities are the identities associated with this user", + "groups": "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.", } func (User) SwaggerDoc() map[string]string { @@ -69,8 +69,8 @@ func (User) SwaggerDoc() map[string]string { var map_UserIdentityMapping = map[string]string{ "": "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).", "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "identity": "Identity is a reference to an identity", - "user": "User is a reference to a user", + "identity": "identity is a reference to an identity", + "user": "user is a reference to a user", } func (UserIdentityMapping) SwaggerDoc() map[string]string { @@ -80,7 +80,7 @@ func (UserIdentityMapping) SwaggerDoc() map[string]string { var map_UserList = map[string]string{ "": "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).", "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", - "items": "Items is the list of users", + "items": "items is the list of users", } func (UserList) SwaggerDoc() map[string]string {