|
| 1 | +""" |
| 2 | +This file was generated by the KCL auto-gen tool. DO NOT EDIT. |
| 3 | +Editing this file might prove futile when you re-run the KCL auto-gen generate command. |
| 4 | +""" |
| 5 | +import k8s.apimachinery.pkg.apis.meta.v1 |
| 6 | + |
| 7 | + |
| 8 | +schema APIServer: |
| 9 | + r""" |
| 10 | + APIServer holds configuration (like serving certificates, client CA and CORS domains) shared by all API servers in the system, among them especially kube-apiserver and openshift-apiserver. The canonical name of an instance is 'cluster'. |
| 11 | + |
| 12 | + Attributes |
| 13 | + ---------- |
| 14 | + apiVersion : str, default is "config.openshift.io/v1", required |
| 15 | + APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
| 16 | + kind : str, default is "APIServer", required |
| 17 | + Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
| 18 | + metadata : v1.ObjectMeta, default is Undefined, optional |
| 19 | + metadata |
| 20 | + spec : ConfigOpenshiftIoV1APIServerSpec, default is Undefined, required |
| 21 | + spec |
| 22 | + status : any, default is Undefined, optional |
| 23 | + status |
| 24 | + """ |
| 25 | + |
| 26 | + |
| 27 | + apiVersion: "config.openshift.io/v1" = "config.openshift.io/v1" |
| 28 | + |
| 29 | + kind: "APIServer" = "APIServer" |
| 30 | + |
| 31 | + metadata?: v1.ObjectMeta |
| 32 | + |
| 33 | + spec: ConfigOpenshiftIoV1APIServerSpec |
| 34 | + |
| 35 | + status?: any |
| 36 | + |
| 37 | + |
| 38 | +schema ConfigOpenshiftIoV1APIServerSpec: |
| 39 | + r""" |
| 40 | + config openshift io v1 API server spec |
| 41 | + |
| 42 | + Attributes |
| 43 | + ---------- |
| 44 | + additionalCORSAllowedOrigins : [str], default is Undefined, optional |
| 45 | + additionalCORSAllowedOrigins lists additional, user-defined regular expressions describing hosts for which the API server allows access using the CORS headers. This may be needed to access the API and the integrated OAuth server from JavaScript applications. The values are regular expressions that correspond to the Golang regular expression language. |
| 46 | + clientCA : ConfigOpenshiftIoV1APIServerSpecClientCA, default is Undefined, optional |
| 47 | + client c a |
| 48 | + encryption : ConfigOpenshiftIoV1APIServerSpecEncryption, default is Undefined, optional |
| 49 | + encryption |
| 50 | + servingCerts : ConfigOpenshiftIoV1APIServerSpecServingCerts, default is Undefined, optional |
| 51 | + serving certs |
| 52 | + tlsSecurityProfile : ConfigOpenshiftIoV1APIServerSpecTLSSecurityProfile, default is Undefined, optional |
| 53 | + tls security profile |
| 54 | + """ |
| 55 | + |
| 56 | + |
| 57 | + additionalCORSAllowedOrigins?: [str] |
| 58 | + |
| 59 | + clientCA?: ConfigOpenshiftIoV1APIServerSpecClientCA |
| 60 | + |
| 61 | + encryption?: ConfigOpenshiftIoV1APIServerSpecEncryption |
| 62 | + |
| 63 | + servingCerts?: ConfigOpenshiftIoV1APIServerSpecServingCerts |
| 64 | + |
| 65 | + tlsSecurityProfile?: ConfigOpenshiftIoV1APIServerSpecTLSSecurityProfile |
| 66 | + |
| 67 | + |
| 68 | +schema ConfigOpenshiftIoV1APIServerSpecClientCA: |
| 69 | + r""" |
| 70 | + clientCA references a ConfigMap containing a certificate bundle for the signers that will be recognized for incoming client certificates in addition to the operator managed signers. If this is empty, then only operator managed signers are valid. You usually only have to set this if you have your own PKI you wish to honor client certificates from. The ConfigMap must exist in the openshift-config namespace and contain the following required fields: - ConfigMap.Data["ca-bundle.crt"] - CA bundle. |
| 71 | + |
| 72 | + Attributes |
| 73 | + ---------- |
| 74 | + name : str, default is Undefined, required |
| 75 | + name is the metadata.name of the referenced config map |
| 76 | + """ |
| 77 | + |
| 78 | + |
| 79 | + name: str |
| 80 | + |
| 81 | + |
| 82 | +schema ConfigOpenshiftIoV1APIServerSpecEncryption: |
| 83 | + r""" |
| 84 | + encryption allows the configuration of encryption of resources at the datastore layer. |
| 85 | + |
| 86 | + Attributes |
| 87 | + ---------- |
| 88 | + $type : str, default is Undefined, optional |
| 89 | + type defines what encryption type should be used to encrypt resources at the datastore layer. When this field is unset (i.e. when it is set to the empty string), identity is implied. The behavior of unset can and will change over time. Even if encryption is enabled by default, the meaning of unset may change to a different encryption type based on changes in best practices. |
| 90 | + When encryption is enabled, all sensitive resources shipped with the platform are encrypted. This list of sensitive resources can and will change over time. The current authoritative list is: |
| 91 | + 1. secrets 2. configmaps 3. routes.route.openshift.io 4. oauthaccesstokens.oauth.openshift.io 5. oauthauthorizetokens.oauth.openshift.io |
| 92 | + """ |
| 93 | + |
| 94 | + |
| 95 | + $type?: "" | "identity" | "aescbc" |
| 96 | + |
| 97 | + |
| 98 | +schema ConfigOpenshiftIoV1APIServerSpecServingCerts: |
| 99 | + r""" |
| 100 | + servingCert is the TLS cert info for serving secure traffic. If not specified, operator managed certificates will be used for serving secure traffic. |
| 101 | + |
| 102 | + Attributes |
| 103 | + ---------- |
| 104 | + namedCertificates : [ConfigOpenshiftIoV1APIServerSpecServingCertsNamedCertificatesItems0], default is Undefined, optional |
| 105 | + namedCertificates references secrets containing the TLS cert info for serving secure traffic to specific hostnames. If no named certificates are provided, or no named certificates match the server name as understood by a client, the defaultServingCertificate will be used. |
| 106 | + """ |
| 107 | + |
| 108 | + |
| 109 | + namedCertificates?: [ConfigOpenshiftIoV1APIServerSpecServingCertsNamedCertificatesItems0] |
| 110 | + |
| 111 | + |
| 112 | +schema ConfigOpenshiftIoV1APIServerSpecServingCertsNamedCertificatesItems0: |
| 113 | + r""" |
| 114 | + APIServerNamedServingCert maps a server DNS name, as understood by a client, to a certificate. |
| 115 | + |
| 116 | + Attributes |
| 117 | + ---------- |
| 118 | + names : [str], default is Undefined, optional |
| 119 | + names is a optional list of explicit DNS names (leading wildcards allowed) that should use this certificate to serve secure traffic. If no names are provided, the implicit names will be extracted from the certificates. Exact names trump over wildcard names. Explicit names defined here trump over extracted implicit names. |
| 120 | + servingCertificate : ConfigOpenshiftIoV1APIServerSpecServingCertsNamedCertificatesItems0ServingCertificate, default is Undefined, optional |
| 121 | + serving certificate |
| 122 | + """ |
| 123 | + |
| 124 | + |
| 125 | + names?: [str] |
| 126 | + |
| 127 | + servingCertificate?: ConfigOpenshiftIoV1APIServerSpecServingCertsNamedCertificatesItems0ServingCertificate |
| 128 | + |
| 129 | + |
| 130 | +schema ConfigOpenshiftIoV1APIServerSpecServingCertsNamedCertificatesItems0ServingCertificate: |
| 131 | + r""" |
| 132 | + servingCertificate references a kubernetes.io/tls type secret containing the TLS cert info for serving secure traffic. The secret must exist in the openshift-config namespace and contain the following required fields: - Secret.Data["tls.key"] - TLS private key. - Secret.Data["tls.crt"] - TLS certificate. |
| 133 | + |
| 134 | + Attributes |
| 135 | + ---------- |
| 136 | + name : str, default is Undefined, required |
| 137 | + name is the metadata.name of the referenced secret |
| 138 | + """ |
| 139 | + |
| 140 | + |
| 141 | + name: str |
| 142 | + |
| 143 | + |
| 144 | +schema ConfigOpenshiftIoV1APIServerSpecTLSSecurityProfile: |
| 145 | + r""" |
| 146 | + tlsSecurityProfile specifies settings for TLS connections for externally exposed servers. |
| 147 | + If unset, a default (which may change between releases) is chosen. Note that only Old and Intermediate profiles are currently supported, and the maximum available MinTLSVersions is VersionTLS12. |
| 148 | + |
| 149 | + Attributes |
| 150 | + ---------- |
| 151 | + custom : ConfigOpenshiftIoV1APIServerSpecTLSSecurityProfileCustom, default is Undefined, optional |
| 152 | + custom |
| 153 | + intermediate : any, default is Undefined, optional |
| 154 | + intermediate is a TLS security profile based on: |
| 155 | + https://wiki.mozilla.org/Security/Server_Side_TLS#Intermediate_compatibility_.28recommended.29 |
| 156 | + and looks like this (yaml): |
| 157 | + ciphers: - TLS_AES_128_GCM_SHA256 - TLS_AES_256_GCM_SHA384 - TLS_CHACHA20_POLY1305_SHA256 - ECDHE-ECDSA-AES128-GCM-SHA256 - ECDHE-RSA-AES128-GCM-SHA256 - ECDHE-ECDSA-AES256-GCM-SHA384 - ECDHE-RSA-AES256-GCM-SHA384 - ECDHE-ECDSA-CHACHA20-POLY1305 - ECDHE-RSA-CHACHA20-POLY1305 - DHE-RSA-AES128-GCM-SHA256 - DHE-RSA-AES256-GCM-SHA384 minTLSVersion: TLSv1.2 |
| 158 | + modern : any, default is Undefined, optional |
| 159 | + modern is a TLS security profile based on: |
| 160 | + https://wiki.mozilla.org/Security/Server_Side_TLS#Modern_compatibility |
| 161 | + and looks like this (yaml): |
| 162 | + ciphers: - TLS_AES_128_GCM_SHA256 - TLS_AES_256_GCM_SHA384 - TLS_CHACHA20_POLY1305_SHA256 minTLSVersion: TLSv1.3 |
| 163 | + NOTE: Currently unsupported. |
| 164 | + old : any, default is Undefined, optional |
| 165 | + old is a TLS security profile based on: |
| 166 | + https://wiki.mozilla.org/Security/Server_Side_TLS#Old_backward_compatibility |
| 167 | + and looks like this (yaml): |
| 168 | + ciphers: - TLS_AES_128_GCM_SHA256 - TLS_AES_256_GCM_SHA384 - TLS_CHACHA20_POLY1305_SHA256 - ECDHE-ECDSA-AES128-GCM-SHA256 - ECDHE-RSA-AES128-GCM-SHA256 - ECDHE-ECDSA-AES256-GCM-SHA384 - ECDHE-RSA-AES256-GCM-SHA384 - ECDHE-ECDSA-CHACHA20-POLY1305 - ECDHE-RSA-CHACHA20-POLY1305 - DHE-RSA-AES128-GCM-SHA256 - DHE-RSA-AES256-GCM-SHA384 - DHE-RSA-CHACHA20-POLY1305 - ECDHE-ECDSA-AES128-SHA256 - ECDHE-RSA-AES128-SHA256 - ECDHE-ECDSA-AES128-SHA - ECDHE-RSA-AES128-SHA - ECDHE-ECDSA-AES256-SHA384 - ECDHE-RSA-AES256-SHA384 - ECDHE-ECDSA-AES256-SHA - ECDHE-RSA-AES256-SHA - DHE-RSA-AES128-SHA256 - DHE-RSA-AES256-SHA256 - AES128-GCM-SHA256 - AES256-GCM-SHA384 - AES128-SHA256 - AES256-SHA256 - AES128-SHA - AES256-SHA - DES-CBC3-SHA minTLSVersion: TLSv1.0 |
| 169 | + $type : str, default is Undefined, optional |
| 170 | + type is one of Old, Intermediate, Modern or Custom. Custom provides the ability to specify individual TLS security profile parameters. Old, Intermediate and Modern are TLS security profiles based on: |
| 171 | + https://wiki.mozilla.org/Security/Server_Side_TLS#Recommended_configurations |
| 172 | + The profiles are intent based, so they may change over time as new ciphers are developed and existing ciphers are found to be insecure. Depending on precisely which ciphers are available to a process, the list may be reduced. |
| 173 | + Note that the Modern profile is currently not supported because it is not yet well adopted by common software libraries. |
| 174 | + """ |
| 175 | + |
| 176 | + |
| 177 | + custom?: ConfigOpenshiftIoV1APIServerSpecTLSSecurityProfileCustom |
| 178 | + |
| 179 | + intermediate?: any |
| 180 | + |
| 181 | + modern?: any |
| 182 | + |
| 183 | + old?: any |
| 184 | + |
| 185 | + $type?: str |
| 186 | + |
| 187 | + |
| 188 | +schema ConfigOpenshiftIoV1APIServerSpecTLSSecurityProfileCustom: |
| 189 | + r""" |
| 190 | + custom is a user-defined TLS security profile. Be extremely careful using a custom profile as invalid configurations can be catastrophic. An example custom profile looks like this: |
| 191 | + ciphers: - ECDHE-ECDSA-CHACHA20-POLY1305 - ECDHE-RSA-CHACHA20-POLY1305 - ECDHE-RSA-AES128-GCM-SHA256 - ECDHE-ECDSA-AES128-GCM-SHA256 minTLSVersion: TLSv1.1 |
| 192 | + |
| 193 | + Attributes |
| 194 | + ---------- |
| 195 | + ciphers : [str], default is Undefined, optional |
| 196 | + ciphers is used to specify the cipher algorithms that are negotiated during the TLS handshake. Operators may remove entries their operands do not support. For example, to use DES-CBC3-SHA (yaml): |
| 197 | + ciphers: - DES-CBC3-SHA |
| 198 | + minTLSVersion : str, default is Undefined, optional |
| 199 | + minTLSVersion is used to specify the minimal version of the TLS protocol that is negotiated during the TLS handshake. For example, to use TLS versions 1.1, 1.2 and 1.3 (yaml): |
| 200 | + minTLSVersion: TLSv1.1 |
| 201 | + NOTE: currently the highest minTLSVersion allowed is VersionTLS12 |
| 202 | + """ |
| 203 | + |
| 204 | + |
| 205 | + ciphers?: [str] |
| 206 | + |
| 207 | + minTLSVersion?: str |
| 208 | + |
| 209 | + |
0 commit comments