|
| 1 | +# Copyright 2025 StreamNative |
| 2 | +# |
| 3 | +# Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 | +# you may not use this file except in compliance with the License. |
| 5 | +# You may obtain a copy of the License at |
| 6 | +# |
| 7 | +# http://www.apache.org/licenses/LICENSE-2.0 |
| 8 | +# |
| 9 | +# Unless required by applicable law or agreed to in writing, software |
| 10 | +# distributed under the License is distributed on an "AS IS" BASIS, |
| 11 | +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 | +# See the License for the specific language governing permissions and |
| 13 | +# limitations under the License. |
| 14 | + |
| 15 | +--- |
| 16 | +apiVersion: apiextensions.k8s.io/v1 |
| 17 | +kind: CustomResourceDefinition |
| 18 | +metadata: |
| 19 | + annotations: |
| 20 | + controller-gen.kubebuilder.io/version: v0.15.0 |
| 21 | + name: apikeys.resource.streamnative.io |
| 22 | +spec: |
| 23 | + group: resource.streamnative.io |
| 24 | + names: |
| 25 | + categories: |
| 26 | + - streamnative |
| 27 | + - all |
| 28 | + kind: APIKey |
| 29 | + listKind: APIKeyList |
| 30 | + plural: apikeys |
| 31 | + singular: apikey |
| 32 | + scope: Namespaced |
| 33 | + versions: |
| 34 | + - additionalPrinterColumns: |
| 35 | + - jsonPath: .metadata.creationTimestamp |
| 36 | + name: AGE |
| 37 | + type: date |
| 38 | + - jsonPath: .status.conditions[?(@.type=="Ready")].status |
| 39 | + name: READY |
| 40 | + type: string |
| 41 | + name: v1alpha1 |
| 42 | + schema: |
| 43 | + openAPIV3Schema: |
| 44 | + description: APIKey is the Schema for the APIKeys API |
| 45 | + properties: |
| 46 | + apiVersion: |
| 47 | + description: |- |
| 48 | + APIVersion defines the versioned schema of this representation of an object. |
| 49 | + Servers should convert recognized schemas to the latest internal value, and |
| 50 | + may reject unrecognized values. |
| 51 | + More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
| 52 | + type: string |
| 53 | + kind: |
| 54 | + description: |- |
| 55 | + Kind is a string value representing the REST resource this object represents. |
| 56 | + Servers may infer this from the endpoint the client submits requests to. |
| 57 | + Cannot be updated. |
| 58 | + In CamelCase. |
| 59 | + More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
| 60 | + type: string |
| 61 | + metadata: |
| 62 | + type: object |
| 63 | + spec: |
| 64 | + description: APIKeySpec defines the desired state of APIKey |
| 65 | + properties: |
| 66 | + apiServerRef: |
| 67 | + description: APIServerRef is the reference to the StreamNativeCloudConnection |
| 68 | + properties: |
| 69 | + name: |
| 70 | + default: "" |
| 71 | + description: |- |
| 72 | + Name of the referent. |
| 73 | + This field is effectively required, but due to backwards compatibility is |
| 74 | + allowed to be empty. Instances of this type with an empty value here are |
| 75 | + almost certainly wrong. |
| 76 | + TODO: Add other useful fields. apiVersion, kind, uid? |
| 77 | + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| 78 | + TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896. |
| 79 | + type: string |
| 80 | + type: object |
| 81 | + x-kubernetes-map-type: atomic |
| 82 | + description: |
| 83 | + description: Description is a user defined description of the key |
| 84 | + type: string |
| 85 | + encryptionKey: |
| 86 | + description: EncryptionKey contains the public key used to encrypt |
| 87 | + the token |
| 88 | + properties: |
| 89 | + pem: |
| 90 | + description: PEM is the public key in PEM format |
| 91 | + type: string |
| 92 | + type: object |
| 93 | + x-kubernetes-map-type: atomic |
| 94 | + expirationTime: |
| 95 | + description: |- |
| 96 | + ExpirationTime is a timestamp that defines when this API key will expire |
| 97 | + This can only be set on initial creation and not updated later |
| 98 | + format: date-time |
| 99 | + type: string |
| 100 | + exportPlaintextToken: |
| 101 | + description: ExportPlaintextToken indicates whether the token should |
| 102 | + be exported in plaintext |
| 103 | + type: boolean |
| 104 | + instanceName: |
| 105 | + description: InstanceName is the name of the instance this API key |
| 106 | + is for |
| 107 | + type: string |
| 108 | + revoke: |
| 109 | + description: Revoke indicates whether this API key should be revoked |
| 110 | + type: boolean |
| 111 | + serviceAccountName: |
| 112 | + description: ServiceAccountName is the name of the service account |
| 113 | + this API key is for |
| 114 | + type: string |
| 115 | + required: |
| 116 | + - apiServerRef |
| 117 | + type: object |
| 118 | + status: |
| 119 | + description: APIKeyStatus defines the observed state of APIKey |
| 120 | + properties: |
| 121 | + conditions: |
| 122 | + description: Conditions represent the latest available observations |
| 123 | + of an object's state |
| 124 | + items: |
| 125 | + description: "Condition contains details for one aspect of the current |
| 126 | + state of this API Resource.\n---\nThis struct is intended for |
| 127 | + direct use as an array at the field path .status.conditions. For |
| 128 | + example,\n\n\n\ttype FooStatus struct{\n\t // Represents the |
| 129 | + observations of a foo's current state.\n\t // Known .status.conditions.type |
| 130 | + are: \"Available\", \"Progressing\", and \"Degraded\"\n\t // |
| 131 | + +patchMergeKey=type\n\t // +patchStrategy=merge\n\t // +listType=map\n\t |
| 132 | + \ // +listMapKey=type\n\t Conditions []metav1.Condition `json:\"conditions,omitempty\" |
| 133 | + patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`\n\n\n\t |
| 134 | + \ // other fields\n\t}" |
| 135 | + properties: |
| 136 | + lastTransitionTime: |
| 137 | + description: |- |
| 138 | + lastTransitionTime is the last time the condition transitioned from one status to another. |
| 139 | + This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. |
| 140 | + format: date-time |
| 141 | + type: string |
| 142 | + message: |
| 143 | + description: |- |
| 144 | + message is a human readable message indicating details about the transition. |
| 145 | + This may be an empty string. |
| 146 | + maxLength: 32768 |
| 147 | + type: string |
| 148 | + observedGeneration: |
| 149 | + description: |- |
| 150 | + observedGeneration represents the .metadata.generation that the condition was set based upon. |
| 151 | + For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date |
| 152 | + with respect to the current state of the instance. |
| 153 | + format: int64 |
| 154 | + minimum: 0 |
| 155 | + type: integer |
| 156 | + reason: |
| 157 | + description: |- |
| 158 | + reason contains a programmatic identifier indicating the reason for the condition's last transition. |
| 159 | + Producers of specific condition types may define expected values and meanings for this field, |
| 160 | + and whether the values are considered a guaranteed API. |
| 161 | + The value should be a CamelCase string. |
| 162 | + This field may not be empty. |
| 163 | + maxLength: 1024 |
| 164 | + minLength: 1 |
| 165 | + pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$ |
| 166 | + type: string |
| 167 | + status: |
| 168 | + description: status of the condition, one of True, False, Unknown. |
| 169 | + enum: |
| 170 | + - "True" |
| 171 | + - "False" |
| 172 | + - Unknown |
| 173 | + type: string |
| 174 | + type: |
| 175 | + description: |- |
| 176 | + type of condition in CamelCase or in foo.example.com/CamelCase. |
| 177 | + --- |
| 178 | + Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be |
| 179 | + useful (see .node.status.conditions), the ability to deconflict is important. |
| 180 | + The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt) |
| 181 | + maxLength: 316 |
| 182 | + 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])$ |
| 183 | + type: string |
| 184 | + required: |
| 185 | + - lastTransitionTime |
| 186 | + - message |
| 187 | + - reason |
| 188 | + - status |
| 189 | + - type |
| 190 | + type: object |
| 191 | + type: array |
| 192 | + encryptedToken: |
| 193 | + description: EncryptedToken is the encrypted security token issued |
| 194 | + for the key |
| 195 | + properties: |
| 196 | + jwe: |
| 197 | + description: |- |
| 198 | + JWE is the token as a JSON Web Encryption (JWE) message |
| 199 | + For RSA public keys, the key encryption algorithm is RSA-OAEP, and the content encryption algorithm is AES GCM |
| 200 | + type: string |
| 201 | + type: object |
| 202 | + x-kubernetes-map-type: atomic |
| 203 | + expiresAt: |
| 204 | + description: ExpiresAt is a timestamp of when the key expires |
| 205 | + format: date-time |
| 206 | + type: string |
| 207 | + issuedAt: |
| 208 | + description: IssuedAt is a timestamp of when the key was issued |
| 209 | + format: date-time |
| 210 | + type: string |
| 211 | + keyId: |
| 212 | + description: KeyID is a generated field that is a uid for the token |
| 213 | + type: string |
| 214 | + observedGeneration: |
| 215 | + description: ObservedGeneration is the last observed generation |
| 216 | + format: int64 |
| 217 | + type: integer |
| 218 | + revokedAt: |
| 219 | + description: RevokedAt is a timestamp of when the key was revoked, |
| 220 | + it triggers revocation action |
| 221 | + format: date-time |
| 222 | + type: string |
| 223 | + token: |
| 224 | + description: Token is the plaintext security token issued for the |
| 225 | + key |
| 226 | + type: string |
| 227 | + type: object |
| 228 | + type: object |
| 229 | + served: true |
| 230 | + storage: true |
| 231 | + subresources: |
| 232 | + status: {} |
0 commit comments