Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add init containers for exec node #288

Merged
merged 1 commit into from
Jun 20, 2024
Merged

Add init containers for exec node #288

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion api/v1/ytsaurus_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -276,6 +276,7 @@ type MastersSpec struct {
MaxSnapshotCountToKeep *int `json:"maxSnapshotCountToKeep,omitempty"`
MaxChangelogCountToKeep *int `json:"maxChangelogCountToKeep,omitempty"`

// List of sidecar containers as yaml of core/v1 Container.
Sidecars []string `json:"sidecars,omitempty"`
}

Expand Down Expand Up @@ -415,7 +416,9 @@ type ExecNodesSpec struct {
//+kubebuilder:default:=default
//+kubebuilder:validation:MinLength:=1
Name string `json:"name,omitempty"`
// List of sidecar containers as yaml of corev1.Container.
// List of init containers as yaml of core/v1 Container.
InitContainers []string `json:"initContainers,omitempty"`
// List of sidecar containers as yaml of core/v1 Container.
Sidecars []string `json:"sidecars,omitempty"`
//+kubebuilder:default:=true
//+optional
Expand Down
5 changes: 4 additions & 1 deletion api/v1/ytsaurus_webhook.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -241,7 +241,7 @@ func validateSidecars(sidecars []string, path *field.Path) field.ErrorList {
names := make(map[string]bool)
for i, sidecarSpec := range sidecars {
sidecar := corev1.Container{}
if err := yaml.Unmarshal([]byte(sidecarSpec), &sidecar); err != nil {
if err := yaml.UnmarshalStrict([]byte(sidecarSpec), &sidecar); err != nil {
allErrors = append(allErrors, field.Invalid(path.Index(i), sidecarSpec, err.Error()))
}
if _, exists := names[sidecar.Name]; exists {
Expand Down Expand Up @@ -275,6 +275,9 @@ func (r *Ytsaurus) validateExecNodes(*Ytsaurus) field.ErrorList {
allErrors = append(allErrors, field.NotFound(path.Child("locations"), LocationTypeSlots))
}

if en.InitContainers != nil {
allErrors = append(allErrors, validateSidecars(en.InitContainers, path.Child("initContainers"))...)
}
if en.Sidecars != nil {
allErrors = append(allErrors, validateSidecars(en.Sidecars, path.Child("sidecars"))...)
}
Expand Down
5 changes: 5 additions & 0 deletions api/v1/zz_generated.deepcopy.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 6 additions & 1 deletion config/crd/bases/cluster.ytsaurus.tech_remoteexecnodes.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -690,6 +690,11 @@ spec:
type: object
x-kubernetes-map-type: atomic
type: array
initContainers:
description: List of init containers as yaml of core/v1 Container.
items:
type: string
type: array
instanceCount:
format: int32
type: integer
Expand Down Expand Up @@ -1078,7 +1083,7 @@ spec:
runtimeClassName:
type: string
sidecars:
description: List of sidecar containers as yaml of corev1.Container.
description: List of sidecar containers as yaml of core/v1 Container.
items:
type: string
type: array
Expand Down
9 changes: 8 additions & 1 deletion config/crd/bases/cluster.ytsaurus.tech_ytsaurus.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7803,6 +7803,11 @@ spec:
image:
description: Overrides coreImage for component.
type: string
initContainers:
description: List of init containers as yaml of core/v1 Container.
items:
type: string
type: array
instanceCount:
format: int32
type: integer
Expand Down Expand Up @@ -8183,7 +8188,7 @@ spec:
runtimeClassName:
type: string
sidecars:
description: List of sidecar containers as yaml of corev1.Container.
description: List of sidecar containers as yaml of core/v1 Container.
items:
type: string
type: array
Expand Down Expand Up @@ -15339,6 +15344,7 @@ spec:
runtimeClassName:
type: string
sidecars:
description: List of sidecar containers as yaml of core/v1 Container.
items:
type: string
type: array
Expand Down Expand Up @@ -27074,6 +27080,7 @@ spec:
runtimeClassName:
type: string
sidecars:
description: List of sidecar containers as yaml of core/v1 Container.
items:
type: string
type: array
Expand Down
8 changes: 5 additions & 3 deletions docs/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -458,7 +458,8 @@ _Appears in:_
| `tags` _string array_ | List of the node tags. | | |
| `rack` _string_ | Name of the node rack. | | |
| `name` _string_ | | default | MinLength: 1 <br /> |
| `sidecars` _string array_ | List of sidecar containers as yaml of corev1.Container. | | |
| `initContainers` _string array_ | List of init containers as yaml of core/v1 Container. | | |
| `sidecars` _string array_ | List of sidecar containers as yaml of core/v1 Container. | | |
| `privileged` _boolean_ | | true | |
| `jobProxyLoggers` _[TextLoggerSpec](#textloggerspec) array_ | | | |
| `jobResources` _[ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#resourcerequirements-v1-core)_ | Resources dedicated for running jobs. | | |
Expand Down Expand Up @@ -865,7 +866,7 @@ _Appears in:_
| `hostAddressLabel` _string_ | | | |
| `maxSnapshotCountToKeep` _integer_ | | | |
| `maxChangelogCountToKeep` _integer_ | | | |
| `sidecars` _string array_ | | | |
| `sidecars` _string array_ | List of sidecar containers as yaml of core/v1 Container. | | |


#### OauthServiceSpec
Expand Down Expand Up @@ -1115,7 +1116,8 @@ _Appears in:_
| `tags` _string array_ | List of the node tags. | | |
| `rack` _string_ | Name of the node rack. | | |
| `name` _string_ | | default | MinLength: 1 <br /> |
| `sidecars` _string array_ | List of sidecar containers as yaml of corev1.Container. | | |
| `initContainers` _string array_ | List of init containers as yaml of core/v1 Container. | | |
| `sidecars` _string array_ | List of sidecar containers as yaml of core/v1 Container. | | |
| `privileged` _boolean_ | | true | |
| `jobProxyLoggers` _[TextLoggerSpec](#textloggerspec) array_ | | | |
| `jobResources` _[ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#resourcerequirements-v1-core)_ | Resources dedicated for running jobs. | | |
Expand Down
57 changes: 33 additions & 24 deletions pkg/components/exec_node_base.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,39 @@ func (n *baseExecNode) doBuildBase() error {
statefulSet := n.server.buildStatefulSet()
podSpec := &statefulSet.Spec.Template.Spec

if len(podSpec.Containers) != 1 {
log.Panicf("Number of exec node containers is expected to be 1, actual %v", len(podSpec.Containers))
}

if err := AddInitContainersToPodSpec(n.spec.InitContainers, podSpec); err != nil {
return err
}

if err := AddSidecarsToPodSpec(n.spec.Sidecars, podSpec); err != nil {
return err
}

setContainerPrivileged := func(ct *corev1.Container) {
if ct.SecurityContext == nil {
ct.SecurityContext = &corev1.SecurityContext{}
}
if ct.SecurityContext.Privileged == nil {
ct.SecurityContext.Privileged = ptr.Bool(n.spec.Privileged)
}
}

for i := range podSpec.InitContainers {
setContainerPrivileged(&podSpec.InitContainers[i])
}

for i := range podSpec.Containers {
setContainerPrivileged(&podSpec.Containers[i])

if envSpec := n.spec.JobEnvironment; envSpec != nil && envSpec.CRI != nil {
n.addEnvironmentForCRITools(&podSpec.Containers[i])
}
}

// Pour job resources into node container if jobs are not isolated.
if n.spec.JobResources != nil && !n.IsJobEnvironmentIsolated() {
addResourceList := func(list, newList corev1.ResourceList) {
Expand All @@ -61,26 +94,6 @@ func (n *baseExecNode) doBuildBase() error {
addResourceList(podSpec.Containers[0].Resources.Limits, n.spec.JobResources.Limits)
}

setContainerPrivileged := func(ct *corev1.Container) {
if ct.SecurityContext == nil {
ct.SecurityContext = &corev1.SecurityContext{}
}
ct.SecurityContext.Privileged = ptr.Bool(n.spec.Privileged)
}

if len(podSpec.Containers) != 1 {
log.Panicf("Number of exec node containers is expected to be 1, actual %v", len(podSpec.Containers))
}
setContainerPrivileged(&podSpec.Containers[0])

if envSpec := n.spec.JobEnvironment; envSpec != nil && envSpec.CRI != nil {
n.addEnvironmentForCRITools(&podSpec.Containers[0])
}

for i := range podSpec.InitContainers {
setContainerPrivileged(&podSpec.InitContainers[i])
}

if n.IsJobEnvironmentIsolated() {
// Add sidecar container for running jobs.
if envSpec := n.spec.JobEnvironment; envSpec != nil && envSpec.CRI != nil {
Expand All @@ -97,10 +110,6 @@ func (n *baseExecNode) doBuildBase() error {
})
}

if err := AddSidecarsToPodSpec(n.spec.Sidecars, podSpec); err != nil {
return err
}

if n.sidecarConfig != nil {
podSpec.Volumes = append(podSpec.Volumes, createConfigVolume(consts.ContainerdConfigVolumeName,
n.sidecarConfig.labeller.GetSidecarConfigMapName(consts.JobsContainerName), nil))
Expand Down
14 changes: 13 additions & 1 deletion pkg/components/helpers.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,10 +209,22 @@ func AddAffinity(statefulSet *appsv1.StatefulSet,
func AddSidecarsToPodSpec(sidecar []string, podSpec *corev1.PodSpec) error {
for _, sidecarSpec := range sidecar {
sidecar := corev1.Container{}
if err := yaml.Unmarshal([]byte(sidecarSpec), &sidecar); err != nil {
if err := yaml.UnmarshalStrict([]byte(sidecarSpec), &sidecar); err != nil {
return err
}
podSpec.Containers = append(podSpec.Containers, sidecar)
}
return nil
}

func AddInitContainersToPodSpec(initContainers []string, podSpec *corev1.PodSpec) error {
containers := make([]corev1.Container, len(initContainers), len(initContainers)+len(podSpec.InitContainers))
for i, spec := range initContainers {
if err := yaml.UnmarshalStrict([]byte(spec), &containers[i]); err != nil {
return err
}
}
// Insert new containers into head
podSpec.InitContainers = append(containers, podSpec.InitContainers...)
return nil
}
7 changes: 6 additions & 1 deletion ytop-chart/templates/remoteexecnodes-crd.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -674,6 +674,11 @@ spec:
type: object
x-kubernetes-map-type: atomic
type: array
initContainers:
description: List of init containers as yaml of core/v1 Container.
items:
type: string
type: array
instanceCount:
format: int32
type: integer
Expand Down Expand Up @@ -1062,7 +1067,7 @@ spec:
runtimeClassName:
type: string
sidecars:
description: List of sidecar containers as yaml of corev1.Container.
description: List of sidecar containers as yaml of core/v1 Container.
items:
type: string
type: array
Expand Down
9 changes: 8 additions & 1 deletion ytop-chart/templates/ytsaurus-crd.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7759,6 +7759,11 @@ spec:
image:
description: Overrides coreImage for component.
type: string
initContainers:
description: List of init containers as yaml of core/v1 Container.
items:
type: string
type: array
instanceCount:
format: int32
type: integer
Expand Down Expand Up @@ -8139,7 +8144,7 @@ spec:
runtimeClassName:
type: string
sidecars:
description: List of sidecar containers as yaml of corev1.Container.
description: List of sidecar containers as yaml of core/v1 Container.
items:
type: string
type: array
Expand Down Expand Up @@ -15252,6 +15257,7 @@ spec:
runtimeClassName:
type: string
sidecars:
description: List of sidecar containers as yaml of core/v1 Container.
items:
type: string
type: array
Expand Down Expand Up @@ -26896,6 +26902,7 @@ spec:
runtimeClassName:
type: string
sidecars:
description: List of sidecar containers as yaml of core/v1 Container.
items:
type: string
type: array
Expand Down
Loading