You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Mar 24, 2025. It is now read-only.
|`ingress`_[CapsuleInterfaceIngress](#capsuleinterfaceingress)_| Ingress specifies that this interface should be exposed through anIngress resource. The Ingress field is mutually exclusive with theLoadBalancer field. |
95
-
|`loadBalancer`_[CapsuleInterfaceLoadBalancer](#capsuleinterfaceloadbalancer)_| LoadBalancer specifies that this interface should be exposed through aLoadBalancer Service. The LoadBalancer field is mutually exclusive withthe 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. |
96
99
97
100
98
101
### CapsuleSpec
@@ -108,31 +111,32 @@ _Appears in:_
108
111
| --- | --- |
109
112
|`replicas`_integer_| Replicas specifies how many replicas the Capsule should have. |
110
113
|`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, thecontainer will run using what is specified as ENTRYPOINT in theDockerfile. |
112
-
|`args`_string array_| Args is a list of arguments either passed to the Command or if Commandis left empty the arguments will be passed to the ENTRYPOINT of thedocker image. |
113
-
|`interfaces`_[CapsuleInterface](#capsuleinterface) array_| Interfaces specifies the list of interfaces the the container shouldhave. Specifying interfaces will create the corresponding kubernetesServices and Ingresses depending on how the interface is configured. |
114
-
|`env`_[Env](#env)_| Env specifies configuration for how the container should obtainenvironment variables. |
115
-
|`files`_[File](#file) array_| Files is a list of files to mount in the container. These can either bebased 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. |
116
119
|`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 credentialsfor 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. |
118
121
|`horizontalScale`_[HorizontalScale](#horizontalscale)_| HorizontalScale describes how the Capsule should scale out |
119
-
|`serviceAccountName`_string_| ServiceAccountName specifies the name of an existing ServiceAccountwhich the Capsule should run as. |
122
+
|`serviceAccountName`_string_| ServiceAccountName specifies the name of an existing ServiceAccount<br /><br />which the Capsule should run as. |
120
123
|`nodeSelector`_object (keys:string, values:string)_| NodeSelector is a selector for what nodes the Capsule should live on. |
121
124
122
125
123
126
### Env
124
127
125
128
126
129
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.
128
132
129
133
_Appears in:_
130
134
-[CapsuleSpec](#capsulespec)
131
135
132
136
| Field | Description |
133
137
| --- | --- |
134
-
|`automatic`_boolean_| Automatic sets wether the capsule should automatically use existingsecrets and configmaps which share the same name as the capsule asenvironment variables. |
135
-
|`from`_[EnvSource](#envsource) array_| From holds a list of references to secrets and configmaps which shouldbe 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. |
136
140
137
141
138
142
### EnvSource
@@ -161,16 +165,17 @@ _Appears in:_
161
165
162
166
| Field | Description |
163
167
| --- | --- |
164
-
|`path`_string_| Path specifies the full path where the File should be mounted includingthe file name. |
165
-
|`configMap`_[FileContentRef](#filecontentref)_| ConfigMap specifies that this file is based on a key in a ConfigMap. TheConfigMap field is mutually exclusive with Secret. |
166
-
|`secret`_[FileContentRef](#filecontentref)_| Secret specifies that this file is based on a key in a Secret. TheSecret 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. |
167
171
168
172
169
173
### FileContentRef
170
174
171
175
172
176
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
174
179
175
180
_Appears in:_
176
181
-[File](#file)
@@ -185,16 +190,17 @@ _Appears in:_
185
190
186
191
187
192
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
189
195
190
196
_Appears in:_
191
197
-[CapsuleSpec](#capsulespec)
192
198
193
199
| Field | Description |
194
200
| --- | --- |
195
-
|`minReplicas`_integer_| MinReplicas is the minimum amount of replicas that the Capsule shouldhave. |
196
-
|`maxReplicas`_integer_| MaxReplicas is the maximum amount of replicas that the Capsule shouldhave. |
197
-
|`cpuTarget`_[CPUTarget](#cputarget)_| CPUTarget specifies that this Capsule should be scaled using CPUutilization. |
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. |
0 commit comments