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.

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

Implement nodeSelector + taint support #40

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
118 changes: 117 additions & 1 deletion api/v1alpha1/sleepcycle_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ limitations under the License.
package v1alpha1

import (
corev1 "k8s.io/api/core/v1"
v1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/api/resource"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)

Expand Down Expand Up @@ -63,9 +66,122 @@ type SleepCycleSpec struct {
// +kubebuilder:validation:ExclusiveMaximum=false
FailedJobsHistoryLimit int32 `json:"failedJobsHistoryLimit,omitempty"`

Runner RunnerConfig `json:"runner,omitempty"`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why not *RunnerConfig?

}

type Metadata struct {
// Additionnal annotation to merge to the resource associated
// https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/#syntax-and-character-set
Annotations map[string]string `json:"annotations,omitempty"`
// Additionnal labels to merge to the resource associated
// https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#syntax-and-character-set
Labels map[string]string `json:"labels,omitempty"`
}

// RunnerConfig defines the configuration of runner image
type RunnerConfig struct {
Copy link
Member

@akyriako akyriako Nov 19, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it a long time, that this should be the way to go; moving all configuration for runners in a separate struct. But I think it should be introduced as a new api version for this Kind (e.g v1alpha2) and provide a convertor from v1alpha1 to v1alpha2; otherwise it breaks backwards compatibility and existing SleepCycles from previous versions. If you try to run it on a cluster where existing SleepCycles exist, it will break:

image

A small example here: https://suedbroecker.net/2022/03/24/add-a-new-api-version-to-an-existing-operator/ (although the way it describes the changes that need to take place on the controller are a bit debatable and need more thorough analysis)

P.S: the project is not yet upgraded to kubebuilder v4 (still on v3; issue #29 which I am actively working on), so if the latest version of kubebuilder is installed on the development environment any attempt to add a new api will fail.

// +kubebuilder:validation:Optional
// +kubebuilder:default:="akyriako78/rekuberate-io-sleepcycles-runners"
RunnerImage string `json:"runnerImage,omitempty"`
Image string `json:"runnerImage,omitempty"`

// imagePullPolicy define the pull policy for docker image
ImagePullPolicy corev1.PullPolicy `json:"imagePullPolicy,omitempty"`

// imagePullSecrets specifies the secret to use when using private registry
// https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.11/#localobjectreference-v1-core
// +kubebuilder:validation:Optional
ImagePullSecrets []corev1.LocalObjectReference `json:"imagePullSecrets,omitempty"`

// RunAsUser define the id of the user to run in the image
// +kubebuilder:validation:Minimum=1
RunAsUser *int64 `json:"runAsUser,omitempty"`

// nodeSelector can be specified, which set the pod to fit on a node
// https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#nodeselector
// +kubebuilder:validation:Optional

NodeSelector map[string]string `json:"nodeSelector,omitempty"`

// resourceRequirements works exactly like Container resources, the user can specify the limit and the requests
// through this property
// https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
// +kubebuilder:validation:Optional
ResourcesRequirements *corev1.ResourceRequirements `json:"resourcesRequirements,omitempty"`

// tolerations can be specified, which set the pod's tolerations
// https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/#concepts
// +kubebuilder:validation:Optional
Tolerations []corev1.Toleration `json:"tolerations,omitempty"`

// podMetadata allows to add additionnal metadata to the node pods
PodMetadata Metadata `json:"podMetadata,omitempty"`

// priorityClassName can be used to set the priority class applied to the node
// +optional
PriorityClassName *string `json:"priorityClassName,omitempty"`
}

// GetResources returns the sleepcycle runner Kubernetes resource.
func (r *RunnerConfig) GetResources() *v1.ResourceRequirements {
if r.ResourcesRequirements != nil {
return r.ResourcesRequirements
}
return &v1.ResourceRequirements{
Limits: v1.ResourceList{
"cpu": resource.MustParse("10m"),
"memory": resource.MustParse("128mb"),
Copy link
Member

@akyriako akyriako Nov 19, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That is not parsing, lines 132 and 136 need to change to 128Mi

},
Requests: v1.ResourceList{
"cpu": resource.MustParse("10m"),
"memory": resource.MustParse("128mb"),
},
}
}

func (r *RunnerConfig) GetRunAsUser() *int64 {
var defaultUserID int64 = 1000
if r.RunAsUser != nil {
return r.RunAsUser
}

return func(i int64) *int64 { return &i }(defaultUserID)
}

// GetTolerations returns the tolerations for the given node.
func (r *RunnerConfig) GetTolerations() []corev1.Toleration {
return r.Tolerations
}

// GetNodeSelector returns the node selector for the given node.
func (r *RunnerConfig) GetNodeSelector() map[string]string {
return r.NodeSelector
}

// GetImagePullSecrets returns the list of Secrets needed to pull Containers images from private repositories.
func (r *RunnerConfig) GetImagePullSecrets() []corev1.LocalObjectReference {
return r.ImagePullSecrets
}

// GetImagePullPolicy returns the image pull policy to pull containers images.
func (r *RunnerConfig) GetImagePullPolicy() corev1.PullPolicy {
return r.ImagePullPolicy
}

func (r *RunnerConfig) GetPodAnnotations() map[string]string {
return r.PodMetadata.Annotations
}

// GetNodeLabels returns additional labels configured to be applied to each nifi node.
func (r *RunnerConfig) GetPodLabels() map[string]string {
return r.PodMetadata.Labels
}

// GetPriorityClass returns the name of the priority class to use for the given node.
func (r *RunnerConfig) GetPriorityClass() string {
if r.PriorityClassName != nil {
return *r.PriorityClassName
}
return ""
}

// SleepCycleStatus defines the observed state of SleepCycle
Expand Down
85 changes: 82 additions & 3 deletions charts/sleepcycles/templates/sleepcycle-crd.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -65,9 +65,88 @@ spec:
maximum: 3
minimum: 1
type: integer
runnerImage:
default: akyriako78/rekuberate-io-sleepcycles-runners
type: string
runner:
image:
default: akyriako78/rekuberate-io-sleepcycles-runners
type: string
imagePullPolicy:
type: string
imagePullSecrets:
items:
properties:
name:
type: string
type: object
x-kubernetes-map-type: atomic
type: array
runAsUser:
format: int64
minimum: 1
type: integer
nodeSelector:
additionalProperties:
type: string
type: object
podMetadata:
properties:
annotations:
additionalProperties:
type: string
type: object
labels:
additionalProperties:
type: string
type: object
type: object
priorityClassName:
type: string
resourcesRequirements:
properties:
claims:
items:
properties:
name:
type: string
required:
- name
type: object
type: array
x-kubernetes-list-map-keys:
- name
x-kubernetes-list-type: map
limits:
additionalProperties:
anyOf:
- type: integer
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
type: object
requests:
additionalProperties:
anyOf:
- type: integer
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
type: object
type: object
tolerations:
items:
properties:
effect:
type: string
key:
type: string
operator:
type: string
tolerationSeconds:
format: int64
type: integer
value:
type: string
type: object
type: array
shutdown:
pattern: (^((\*\/)?([0-5]?[0-9])((\,|\-|\/)([0-5]?[0-9]))*|\*)\s+((\*\/)?((2[0-3]|1[0-9]|[0-9]|00))((\,|\-|\/)(2[0-3]|1[0-9]|[0-9]|00))*|\*)\s+((\*\/)?([1-9]|[12][0-9]|3[01])((\,|\-|\/)([1-9]|[12][0-9]|3[01]))*|\*)\s+((\*\/)?([1-9]|1[0-2])((\,|\-|\/)([1-9]|1[0-2]))*|\*|(jan|feb|mar|apr|may|jun|jul|aug|sep|oct|nov|des))\s+((\*\/)?[0-6]((\,|\-|\/)[0-6])*|\*|00|(sun|mon|tue|wed|thu|fri|sat))\s*$)|@(annually|yearly|monthly|weekly|daily|hourly|reboot)
type: string
Expand Down
85 changes: 82 additions & 3 deletions config/crd/bases/core.rekuberate.io_sleepcycles.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -65,9 +65,88 @@ spec:
maximum: 3
minimum: 1
type: integer
runnerImage:
default: akyriako78/rekuberate-io-sleepcycles-runners
type: string
runner:
image:
default: akyriako78/rekuberate-io-sleepcycles-runners
type: string
imagePullPolicy:
type: string
imagePullSecrets:
items:
properties:
name:
type: string
type: object
x-kubernetes-map-type: atomic
type: array
runAsUser:
format: int64
minimum: 1
type: integer
nodeSelector:
additionalProperties:
type: string
type: object
podMetadata:
properties:
annotations:
additionalProperties:
type: string
type: object
labels:
additionalProperties:
type: string
type: object
type: object
priorityClassName:
type: string
resourcesRequirements:
properties:
claims:
items:
properties:
name:
type: string
required:
- name
type: object
type: array
x-kubernetes-list-map-keys:
- name
x-kubernetes-list-type: map
limits:
additionalProperties:
anyOf:
- type: integer
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
type: object
requests:
additionalProperties:
anyOf:
- type: integer
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
type: object
type: object
tolerations:
items:
properties:
effect:
type: string
key:
type: string
operator:
type: string
tolerationSeconds:
format: int64
type: integer
value:
type: string
type: object
type: array
shutdown:
pattern: (^((\*\/)?([0-5]?[0-9])((\,|\-|\/)([0-5]?[0-9]))*|\*)\s+((\*\/)?((2[0-3]|1[0-9]|[0-9]|00))((\,|\-|\/)(2[0-3]|1[0-9]|[0-9]|00))*|\*)\s+((\*\/)?([1-9]|[12][0-9]|3[01])((\,|\-|\/)([1-9]|[12][0-9]|3[01]))*|\*)\s+((\*\/)?([1-9]|1[0-2])((\,|\-|\/)([1-9]|1[0-2]))*|\*|(jan|feb|mar|apr|may|jun|jul|aug|sep|oct|nov|des))\s+((\*\/)?[0-6]((\,|\-|\/)[0-6])*|\*|00|(sun|mon|tue|wed|thu|fri|sat))\s*$)|@(annually|yearly|monthly|weekly|daily|hourly|reboot)
type: string
Expand Down
27 changes: 21 additions & 6 deletions controllers/sleepcycle_runners_cronjobs.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,16 @@ package controllers
import (
"context"
"fmt"
"strconv"
"strings"

"github.com/go-logr/logr"
corev1alpha1 "github.com/rekuberate-io/sleepcycles/api/v1alpha1"
batchv1 "k8s.io/api/batch/v1"
v1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
ctrl "sigs.k8s.io/controller-runtime"
"sigs.k8s.io/controller-runtime/pkg/client"
"strconv"
"strings"
)

var (
Expand Down Expand Up @@ -74,8 +75,8 @@ func (r *SleepCycleReconciler) createCronJob(
}

labels := make(map[string]string)
labels[OwnedBy] = fmt.Sprintf("%s", sleepcycle.Name)
labels[Target] = fmt.Sprintf("%s", targetMeta.Name)
labels[OwnedBy] = sleepcycle.Name
labels[Target] = targetMeta.Name
labels[TargetKind] = targetKind

annotations := make(map[string]string)
Expand Down Expand Up @@ -110,8 +111,10 @@ func (r *SleepCycleReconciler) createCronJob(
Spec: v1.PodSpec{
Containers: []v1.Container{
{
Name: cronObjectKey.Name,
Image: sleepcycle.Spec.RunnerImage,
Name: cronObjectKey.Name,
Image: sleepcycle.Spec.Runner.Image,
ImagePullPolicy: sleepcycle.Spec.Runner.GetImagePullPolicy(),
Resources: *sleepcycle.Spec.Runner.GetResources(),
Env: []v1.EnvVar{
{
Name: "MY_POD_NAME",
Expand All @@ -136,6 +139,18 @@ func (r *SleepCycleReconciler) createCronJob(
},
RestartPolicy: v1.RestartPolicyOnFailure,
ServiceAccountName: serviceAccountName,
ImagePullSecrets: sleepcycle.Spec.Runner.GetImagePullSecrets(),
Tolerations: sleepcycle.Spec.Runner.GetTolerations(),
PriorityClassName: sleepcycle.Spec.Runner.GetPriorityClass(),
NodeSelector: sleepcycle.Spec.Runner.GetNodeSelector(),
SecurityContext: &v1.PodSecurityContext{
RunAsUser: sleepcycle.Spec.Runner.GetRunAsUser(),
RunAsNonRoot: func(b bool) *bool { return &b }(true),
},
},
ObjectMeta: metav1.ObjectMeta{
Labels: MergeLabels(labels, sleepcycle.Spec.Runner.GetPodLabels()),
Annotations: MergeAnnotations(annotations, sleepcycle.Spec.Runner.GetPodAnnotations()),
},
},
BackoffLimit: &backOffLimit,
Expand Down
Loading