Skip to content
This repository was archived by the owner on Mar 24, 2025. It is now read-only.

Commit b7b2b01

Browse files
committed
📝 Update controller-gen version
1 parent 6ba8600 commit b7b2b01

File tree

18 files changed

+580
-469
lines changed

18 files changed

+580
-469
lines changed

deploy/charts/rig-operator/templates/crd.yaml

Lines changed: 231 additions & 187 deletions
Large diffs are not rendered by default.

docs/docs/api/config/v1alpha1.md

Lines changed: 82 additions & 59 deletions
Large diffs are not rendered by default.

docs/docs/api/platformv1.md

Lines changed: 58 additions & 50 deletions
Large diffs are not rendered by default.

docs/docs/api/v1alpha1.md

Lines changed: 30 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,15 @@ Package v1alpha1 contains API Schema definitions for the v1alpha1 API group
1616

1717

1818

19-
CPUTarget defines an autoscaler target for the CPU metric If empty, no autoscaling will be done
19+
CPUTarget defines an autoscaler target for the CPU metric
20+
If empty, no autoscaling will be done
2021

2122
_Appears in:_
2223
- [HorizontalScale](#horizontalscale)
2324

2425
| Field | Description |
2526
| --- | --- |
26-
| `averageUtilizationPercentage` _integer_ | AverageUtilizationPercentage sets the utilization which when exceeded will trigger autoscaling. |
27+
| `averageUtilizationPercentage` _integer_ | AverageUtilizationPercentage sets the utilization which when exceeded<br /><br />will trigger autoscaling. |
2728

2829

2930
### Capsule
@@ -62,7 +63,8 @@ _Appears in:_
6263

6364
_Underlying type:_ _[struct{Host string "json:\"host\""}](#struct{host-string-"json:\"host\""})_
6465

65-
CapsuleInterfaceIngress defines that the interface should be exposed as http ingress
66+
CapsuleInterfaceIngress defines that the interface should be exposed as http
67+
ingress
6668

6769
_Appears in:_
6870
- [CapsulePublicInterface](#capsulepublicinterface)
@@ -73,7 +75,8 @@ _Appears in:_
7375

7476
_Underlying type:_ _[struct{Port int32 "json:\"port\""; NodePort int32 "json:\"nodePort,omitempty\""}](#struct{port-int32-"json:\"port\"";-nodeport-int32-"json:\"nodeport,omitempty\""})_
7577

76-
CapsuleInterfaceLoadBalancer defines that the interface should be exposed as a L4 loadbalancer
78+
CapsuleInterfaceLoadBalancer defines that the interface should be exposed as
79+
a L4 loadbalancer
7780

7881
_Appears in:_
7982
- [CapsulePublicInterface](#capsulepublicinterface)
@@ -91,8 +94,8 @@ _Appears in:_
9194

9295
| Field | Description |
9396
| --- | --- |
94-
| `ingress` _[CapsuleInterfaceIngress](#capsuleinterfaceingress)_ | Ingress specifies that this interface should be exposed through an Ingress resource. The Ingress field is mutually exclusive with the LoadBalancer field. |
95-
| `loadBalancer` _[CapsuleInterfaceLoadBalancer](#capsuleinterfaceloadbalancer)_ | LoadBalancer specifies that this interface should be exposed through a LoadBalancer Service. The LoadBalancer field is mutually exclusive with the Ingress field. |
97+
| `ingress` _[CapsuleInterfaceIngress](#capsuleinterfaceingress)_ | Ingress specifies that this interface should be exposed through an<br /><br />Ingress resource. The Ingress field is mutually exclusive with the<br /><br />LoadBalancer field. |
98+
| `loadBalancer` _[CapsuleInterfaceLoadBalancer](#capsuleinterfaceloadbalancer)_ | LoadBalancer specifies that this interface should be exposed through a<br /><br />LoadBalancer Service. The LoadBalancer field is mutually exclusive with<br /><br />the Ingress field. |
9699

97100

98101
### CapsuleSpec
@@ -108,31 +111,32 @@ _Appears in:_
108111
| --- | --- |
109112
| `replicas` _integer_ | Replicas specifies how many replicas the Capsule should have. |
110113
| `image` _string_ | Image specifies what image the Capsule should run. |
111-
| `command` _string_ | Command is run as a command in the shell. If left unspecified, the container will run using what is specified as ENTRYPOINT in the Dockerfile. |
112-
| `args` _string array_ | Args is a list of arguments either passed to the Command or if Command is left empty the arguments will be passed to the ENTRYPOINT of the docker image. |
113-
| `interfaces` _[CapsuleInterface](#capsuleinterface) array_ | Interfaces specifies the list of interfaces the the container should have. Specifying interfaces will create the corresponding kubernetes Services and Ingresses depending on how the interface is configured. |
114-
| `env` _[Env](#env)_ | Env specifies configuration for how the container should obtain environment variables. |
115-
| `files` _[File](#file) array_ | Files is a list of files to mount in the container. These can either be based on ConfigMaps or Secrets. |
114+
| `command` _string_ | Command is run as a command in the shell. If left unspecified, the<br /><br />container will run using what is specified as ENTRYPOINT in the<br /><br />Dockerfile. |
115+
| `args` _string array_ | Args is a list of arguments either passed to the Command or if Command<br /><br />is left empty the arguments will be passed to the ENTRYPOINT of the<br /><br />docker image. |
116+
| `interfaces` _[CapsuleInterface](#capsuleinterface) array_ | Interfaces specifies the list of interfaces the the container should<br /><br />have. Specifying interfaces will create the corresponding kubernetes<br /><br />Services and Ingresses depending on how the interface is configured. |
117+
| `env` _[Env](#env)_ | Env specifies configuration for how the container should obtain<br /><br />environment variables. |
118+
| `files` _[File](#file) array_ | Files is a list of files to mount in the container. These can either be<br /><br />based on ConfigMaps or Secrets. |
116119
| `resources` _[ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#resourcerequirements-v1-core)_ | Resources describes what resources the Capsule should have access to. |
117-
| `imagePullSecret` _[LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#localobjectreference-v1-core)_ | ImagePullSecret is a reference to a secret holding docker credentials for the registry of the image. |
120+
| `imagePullSecret` _[LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#localobjectreference-v1-core)_ | ImagePullSecret is a reference to a secret holding docker credentials<br /><br />for the registry of the image. |
118121
| `horizontalScale` _[HorizontalScale](#horizontalscale)_ | HorizontalScale describes how the Capsule should scale out |
119-
| `serviceAccountName` _string_ | ServiceAccountName specifies the name of an existing ServiceAccount which the Capsule should run as. |
122+
| `serviceAccountName` _string_ | ServiceAccountName specifies the name of an existing ServiceAccount<br /><br />which the Capsule should run as. |
120123
| `nodeSelector` _object (keys:string, values:string)_ | NodeSelector is a selector for what nodes the Capsule should live on. |
121124

122125

123126
### Env
124127

125128

126129

127-
Env defines what secrets and configmaps should be used for environment variables in the capsule.
130+
Env defines what secrets and configmaps should be used for environment
131+
variables in the capsule.
128132

129133
_Appears in:_
130134
- [CapsuleSpec](#capsulespec)
131135

132136
| Field | Description |
133137
| --- | --- |
134-
| `automatic` _boolean_ | Automatic sets wether the capsule should automatically use existing secrets and configmaps which share the same name as the capsule as environment variables. |
135-
| `from` _[EnvSource](#envsource) array_ | From holds a list of references to secrets and configmaps which should be mounted as environment variables. |
138+
| `automatic` _boolean_ | Automatic sets wether the capsule should automatically use existing<br /><br />secrets and configmaps which share the same name as the capsule as<br /><br />environment variables. |
139+
| `from` _[EnvSource](#envsource) array_ | From holds a list of references to secrets and configmaps which should<br /><br />be mounted as environment variables. |
136140

137141

138142
### EnvSource
@@ -161,16 +165,17 @@ _Appears in:_
161165

162166
| Field | Description |
163167
| --- | --- |
164-
| `path` _string_ | Path specifies the full path where the File should be mounted including the file name. |
165-
| `configMap` _[FileContentRef](#filecontentref)_ | ConfigMap specifies that this file is based on a key in a ConfigMap. The ConfigMap field is mutually exclusive with Secret. |
166-
| `secret` _[FileContentRef](#filecontentref)_ | Secret specifies that this file is based on a key in a Secret. The Secret field is mutually exclusive with ConfigMap. |
168+
| `path` _string_ | Path specifies the full path where the File should be mounted including<br /><br />the file name. |
169+
| `configMap` _[FileContentRef](#filecontentref)_ | ConfigMap specifies that this file is based on a key in a ConfigMap. The<br /><br />ConfigMap field is mutually exclusive with Secret. |
170+
| `secret` _[FileContentRef](#filecontentref)_ | Secret specifies that this file is based on a key in a Secret. The<br /><br />Secret field is mutually exclusive with ConfigMap. |
167171

168172

169173
### FileContentRef
170174

171175

172176

173-
FileContentRef defines the name of a config resource and the key from which to retrieve the contents
177+
FileContentRef defines the name of a config resource and the key from which
178+
to retrieve the contents
174179

175180
_Appears in:_
176181
- [File](#file)
@@ -185,16 +190,17 @@ _Appears in:_
185190

186191

187192

188-
HorizontalScale defines the policy for the number of replicas of the capsule It can both be configured with autoscaling and with a static number of replicas
193+
HorizontalScale defines the policy for the number of replicas of the capsule
194+
It can both be configured with autoscaling and with a static number of replicas
189195

190196
_Appears in:_
191197
- [CapsuleSpec](#capsulespec)
192198

193199
| Field | Description |
194200
| --- | --- |
195-
| `minReplicas` _integer_ | MinReplicas is the minimum amount of replicas that the Capsule should have. |
196-
| `maxReplicas` _integer_ | MaxReplicas is the maximum amount of replicas that the Capsule should have. |
197-
| `cpuTarget` _[CPUTarget](#cputarget)_ | CPUTarget specifies that this Capsule should be scaled using CPU utilization. |
201+
| `minReplicas` _integer_ | MinReplicas is the minimum amount of replicas that the Capsule should<br /><br />have. |
202+
| `maxReplicas` _integer_ | MaxReplicas is the maximum amount of replicas that the Capsule should<br /><br />have. |
203+
| `cpuTarget` _[CPUTarget](#cputarget)_ | CPUTarget specifies that this Capsule should be scaled using CPU<br /><br />utilization. |
198204

199205

200206

0 commit comments

Comments
 (0)