Skip to content

Commit d013d45

Browse files
authored
embed the struct (#2508)
1 parent 38df36d commit d013d45

File tree

3 files changed

+272
-3
lines changed

3 files changed

+272
-3
lines changed

apis/v1alpha2/opentelemetrycollector_types.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -115,8 +115,8 @@ type OpenShiftRoute struct {
115115

116116
// OpenTelemetryCollectorSpec defines the desired state of OpenTelemetryCollector.
117117
type OpenTelemetryCollectorSpec struct {
118-
// Common defines fields that are common to all OpenTelemetry CRD workloads.
119-
Common OpenTelemetryCommonFields `json:",inline"`
118+
// OpenTelemetryCommonFields are fields that are on all OpenTelemetry CRD workloads.
119+
OpenTelemetryCommonFields `json:",inline"`
120120
// TargetAllocator indicates a value which determines whether to spawn a target allocation resource or not.
121121
// +optional
122122
TargetAllocator v1alpha1.OpenTelemetryTargetAllocator `json:"targetAllocator,omitempty"`

apis/v1alpha2/zz_generated.deepcopy.go

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/api.md

+269
Original file line numberDiff line numberDiff line change
@@ -18521,6 +18521,13 @@ TargetAllocator indicates a value which determines whether to spawn a target all
1852118521
PodDisruptionBudget specifies the pod disruption budget configuration to use for the target allocator workload.<br/>
1852218522
</td>
1852318523
<td>false</td>
18524+
</tr><tr>
18525+
<td><b><a href="#opentelemetrycollectorspectargetallocatorpodsecuritycontext">podSecurityContext</a></b></td>
18526+
<td>object</td>
18527+
<td>
18528+
PodSecurityContext configures the pod security context for the targetallocator.<br/>
18529+
</td>
18530+
<td>false</td>
1852418531
</tr><tr>
1852518532
<td><b><a href="#opentelemetrycollectorspectargetallocatorprometheuscr">prometheusCR</a></b></td>
1852618533
<td>object</td>
@@ -20268,6 +20275,268 @@ PodDisruptionBudget specifies the pod disruption budget configuration to use for
2026820275
</table>
2026920276

2027020277

20278+
### OpenTelemetryCollector.spec.targetAllocator.podSecurityContext
20279+
<sup><sup>[↩ Parent](#opentelemetrycollectorspectargetallocator)</sup></sup>
20280+
20281+
20282+
20283+
PodSecurityContext configures the pod security context for the targetallocator.
20284+
20285+
<table>
20286+
<thead>
20287+
<tr>
20288+
<th>Name</th>
20289+
<th>Type</th>
20290+
<th>Description</th>
20291+
<th>Required</th>
20292+
</tr>
20293+
</thead>
20294+
<tbody><tr>
20295+
<td><b>fsGroup</b></td>
20296+
<td>integer</td>
20297+
<td>
20298+
A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod:
20299+
1.<br/>
20300+
<br/>
20301+
<i>Format</i>: int64<br/>
20302+
</td>
20303+
<td>false</td>
20304+
</tr><tr>
20305+
<td><b>fsGroupChangePolicy</b></td>
20306+
<td>string</td>
20307+
<td>
20308+
fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod.<br/>
20309+
</td>
20310+
<td>false</td>
20311+
</tr><tr>
20312+
<td><b>runAsGroup</b></td>
20313+
<td>integer</td>
20314+
<td>
20315+
The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext.<br/>
20316+
<br/>
20317+
<i>Format</i>: int64<br/>
20318+
</td>
20319+
<td>false</td>
20320+
</tr><tr>
20321+
<td><b>runAsNonRoot</b></td>
20322+
<td>boolean</td>
20323+
<td>
20324+
Indicates that the container must run as a non-root user.<br/>
20325+
</td>
20326+
<td>false</td>
20327+
</tr><tr>
20328+
<td><b>runAsUser</b></td>
20329+
<td>integer</td>
20330+
<td>
20331+
The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext.<br/>
20332+
<br/>
20333+
<i>Format</i>: int64<br/>
20334+
</td>
20335+
<td>false</td>
20336+
</tr><tr>
20337+
<td><b><a href="#opentelemetrycollectorspectargetallocatorpodsecuritycontextselinuxoptions">seLinuxOptions</a></b></td>
20338+
<td>object</td>
20339+
<td>
20340+
The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext.<br/>
20341+
</td>
20342+
<td>false</td>
20343+
</tr><tr>
20344+
<td><b><a href="#opentelemetrycollectorspectargetallocatorpodsecuritycontextseccompprofile">seccompProfile</a></b></td>
20345+
<td>object</td>
20346+
<td>
20347+
The seccomp options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows.<br/>
20348+
</td>
20349+
<td>false</td>
20350+
</tr><tr>
20351+
<td><b>supplementalGroups</b></td>
20352+
<td>[]integer</td>
20353+
<td>
20354+
A list of groups applied to the first process run in each container, in addition to the container's primary GID, the fsGroup (if specified), and group memberships defined in the container image for th<br/>
20355+
</td>
20356+
<td>false</td>
20357+
</tr><tr>
20358+
<td><b><a href="#opentelemetrycollectorspectargetallocatorpodsecuritycontextsysctlsindex">sysctls</a></b></td>
20359+
<td>[]object</td>
20360+
<td>
20361+
Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. Note that this field cannot be set when spec.os.<br/>
20362+
</td>
20363+
<td>false</td>
20364+
</tr><tr>
20365+
<td><b><a href="#opentelemetrycollectorspectargetallocatorpodsecuritycontextwindowsoptions">windowsOptions</a></b></td>
20366+
<td>object</td>
20367+
<td>
20368+
The Windows specific settings applied to all containers. If unspecified, the options within a container's SecurityContext will be used.<br/>
20369+
</td>
20370+
<td>false</td>
20371+
</tr></tbody>
20372+
</table>
20373+
20374+
20375+
### OpenTelemetryCollector.spec.targetAllocator.podSecurityContext.seLinuxOptions
20376+
<sup><sup>[↩ Parent](#opentelemetrycollectorspectargetallocatorpodsecuritycontext)</sup></sup>
20377+
20378+
20379+
20380+
The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext.
20381+
20382+
<table>
20383+
<thead>
20384+
<tr>
20385+
<th>Name</th>
20386+
<th>Type</th>
20387+
<th>Description</th>
20388+
<th>Required</th>
20389+
</tr>
20390+
</thead>
20391+
<tbody><tr>
20392+
<td><b>level</b></td>
20393+
<td>string</td>
20394+
<td>
20395+
Level is SELinux level label that applies to the container.<br/>
20396+
</td>
20397+
<td>false</td>
20398+
</tr><tr>
20399+
<td><b>role</b></td>
20400+
<td>string</td>
20401+
<td>
20402+
Role is a SELinux role label that applies to the container.<br/>
20403+
</td>
20404+
<td>false</td>
20405+
</tr><tr>
20406+
<td><b>type</b></td>
20407+
<td>string</td>
20408+
<td>
20409+
Type is a SELinux type label that applies to the container.<br/>
20410+
</td>
20411+
<td>false</td>
20412+
</tr><tr>
20413+
<td><b>user</b></td>
20414+
<td>string</td>
20415+
<td>
20416+
User is a SELinux user label that applies to the container.<br/>
20417+
</td>
20418+
<td>false</td>
20419+
</tr></tbody>
20420+
</table>
20421+
20422+
20423+
### OpenTelemetryCollector.spec.targetAllocator.podSecurityContext.seccompProfile
20424+
<sup><sup>[↩ Parent](#opentelemetrycollectorspectargetallocatorpodsecuritycontext)</sup></sup>
20425+
20426+
20427+
20428+
The seccomp options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows.
20429+
20430+
<table>
20431+
<thead>
20432+
<tr>
20433+
<th>Name</th>
20434+
<th>Type</th>
20435+
<th>Description</th>
20436+
<th>Required</th>
20437+
</tr>
20438+
</thead>
20439+
<tbody><tr>
20440+
<td><b>type</b></td>
20441+
<td>string</td>
20442+
<td>
20443+
type indicates which kind of seccomp profile will be applied. Valid options are:
20444+
Localhost - a profile defined in a file on the node should be used.<br/>
20445+
</td>
20446+
<td>true</td>
20447+
</tr><tr>
20448+
<td><b>localhostProfile</b></td>
20449+
<td>string</td>
20450+
<td>
20451+
localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work.<br/>
20452+
</td>
20453+
<td>false</td>
20454+
</tr></tbody>
20455+
</table>
20456+
20457+
20458+
### OpenTelemetryCollector.spec.targetAllocator.podSecurityContext.sysctls[index]
20459+
<sup><sup>[↩ Parent](#opentelemetrycollectorspectargetallocatorpodsecuritycontext)</sup></sup>
20460+
20461+
20462+
20463+
Sysctl defines a kernel parameter to be set
20464+
20465+
<table>
20466+
<thead>
20467+
<tr>
20468+
<th>Name</th>
20469+
<th>Type</th>
20470+
<th>Description</th>
20471+
<th>Required</th>
20472+
</tr>
20473+
</thead>
20474+
<tbody><tr>
20475+
<td><b>name</b></td>
20476+
<td>string</td>
20477+
<td>
20478+
Name of a property to set<br/>
20479+
</td>
20480+
<td>true</td>
20481+
</tr><tr>
20482+
<td><b>value</b></td>
20483+
<td>string</td>
20484+
<td>
20485+
Value of a property to set<br/>
20486+
</td>
20487+
<td>true</td>
20488+
</tr></tbody>
20489+
</table>
20490+
20491+
20492+
### OpenTelemetryCollector.spec.targetAllocator.podSecurityContext.windowsOptions
20493+
<sup><sup>[↩ Parent](#opentelemetrycollectorspectargetallocatorpodsecuritycontext)</sup></sup>
20494+
20495+
20496+
20497+
The Windows specific settings applied to all containers. If unspecified, the options within a container's SecurityContext will be used.
20498+
20499+
<table>
20500+
<thead>
20501+
<tr>
20502+
<th>Name</th>
20503+
<th>Type</th>
20504+
<th>Description</th>
20505+
<th>Required</th>
20506+
</tr>
20507+
</thead>
20508+
<tbody><tr>
20509+
<td><b>gmsaCredentialSpec</b></td>
20510+
<td>string</td>
20511+
<td>
20512+
GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.<br/>
20513+
</td>
20514+
<td>false</td>
20515+
</tr><tr>
20516+
<td><b>gmsaCredentialSpecName</b></td>
20517+
<td>string</td>
20518+
<td>
20519+
GMSACredentialSpecName is the name of the GMSA credential spec to use.<br/>
20520+
</td>
20521+
<td>false</td>
20522+
</tr><tr>
20523+
<td><b>hostProcess</b></td>
20524+
<td>boolean</td>
20525+
<td>
20526+
HostProcess determines if a container should be run as a 'Host Process' container.<br/>
20527+
</td>
20528+
<td>false</td>
20529+
</tr><tr>
20530+
<td><b>runAsUserName</b></td>
20531+
<td>string</td>
20532+
<td>
20533+
The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext.<br/>
20534+
</td>
20535+
<td>false</td>
20536+
</tr></tbody>
20537+
</table>
20538+
20539+
2027120540
### OpenTelemetryCollector.spec.targetAllocator.prometheusCR
2027220541
<sup><sup>[↩ Parent](#opentelemetrycollectorspectargetallocator)</sup></sup>
2027320542

0 commit comments

Comments
 (0)