Skip to content

[Refactor] Init pod creator with an error #831

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

Merged
merged 2 commits into from
Nov 9, 2021
Merged

[Refactor] Init pod creator with an error #831

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d0ad826
init pod creator with an error
informalict Nov 9, 2021
f87b6bb
fix unit tests
informalict Nov 9, 2021
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
6 changes: 4 additions & 2 deletions pkg/deployment/images.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,7 @@ func (ib *imagesBuilder) fetchArangoDBImageIDAndVersion(ctx context.Context, cac
},
}

pod, err = resources.RenderArangoPod(cachedStatus, ib.APIObject, role, id, podName, &imagePod)
pod, err = resources.RenderArangoPod(ctx, cachedStatus, ib.APIObject, role, id, podName, &imagePod)
if err != nil {
log.Debug().Err(err).Msg("Failed to render image ID pod")
return true, errors.WithStack(err)
Expand Down Expand Up @@ -259,10 +259,12 @@ func (i *ImageUpdatePod) GetRole() string {
return "id"
}

func (i *ImageUpdatePod) Init(pod *core.Pod) {
func (i *ImageUpdatePod) Init(_ context.Context, _ interfaces.Inspector, pod *core.Pod) error {
terminationGracePeriodSeconds := int64((time.Second * 30).Seconds())
pod.Spec.TerminationGracePeriodSeconds = &terminationGracePeriodSeconds
pod.Spec.PriorityClassName = i.spec.ID.Get().PriorityClassName

return nil
}

func (i *ImageUpdatePod) GetImagePullSecrets() []string {
Expand Down
86 changes: 21 additions & 65 deletions pkg/deployment/resources/pod_creator.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -348,7 +348,7 @@ func (r *Resources) RenderPodForMember(ctx context.Context, cachedStatus inspect
// Prepare arguments
autoUpgrade := newMember.Conditions.IsTrue(api.ConditionTypeAutoUpgrade) || spec.Upgrade.Get().AutoUpgrade

memberPod := MemberArangoDPod{
podCreator = &MemberArangoDPod{
status: *newMember,
groupSpec: groupSpec,
spec: spec,
Expand All @@ -361,11 +361,6 @@ func (r *Resources) RenderPodForMember(ctx context.Context, cachedStatus inspect
arangoMember: *member,
cachedStatus: cachedStatus,
}

if err := memberPod.Validate(cachedStatus); err != nil {
return nil, errors.WithStack(errors.Wrapf(err, "Validation of pods resources failed"))
}
podCreator = &memberPod
} else if group.IsArangosync() {
// Check image
if !imageInfo.Enterprise {
Expand All @@ -378,67 +373,21 @@ func (r *Resources) RenderPodForMember(ctx context.Context, cachedStatus inspect
imageInfo.Image = spec.Sync.GetSyncImage()
}

var tlsKeyfileSecretName, clientAuthCASecretName, masterJWTSecretName, clusterJWTSecretName string
// Check master JWT secret

masterJWTSecretName = spec.Sync.Authentication.GetJWTSecretName()
err := k8sutil.RunWithTimeout(ctx, func(ctxChild context.Context) error {
return k8sutil.ValidateTokenSecret(ctxChild, cachedStatus.SecretReadInterface(), masterJWTSecretName)
})
if err != nil {
return nil, errors.WithStack(errors.Wrapf(err, "Master JWT secret validation failed"))
}

monitoringTokenSecretName := spec.Sync.Monitoring.GetTokenSecretName()
err = k8sutil.RunWithTimeout(ctx, func(ctxChild context.Context) error {
return k8sutil.ValidateTokenSecret(ctxChild, cachedStatus.SecretReadInterface(), monitoringTokenSecretName)
})
if err != nil {
return nil, errors.WithStack(errors.Wrapf(err, "Monitoring token secret validation failed"))
}

if group == api.ServerGroupSyncMasters {
// Create TLS secret
tlsKeyfileSecretName = k8sutil.CreateTLSKeyfileSecretName(apiObject.GetName(), role, newMember.ID)
// Check cluster JWT secret
if spec.IsAuthenticated() {
clusterJWTSecretName = spec.Authentication.GetJWTSecretName()
err = k8sutil.RunWithTimeout(ctx, func(ctxChild context.Context) error {
return k8sutil.ValidateTokenSecret(ctxChild, cachedStatus.SecretReadInterface(), clusterJWTSecretName)
})
if err != nil {
return nil, errors.WithStack(errors.Wrapf(err, "Cluster JWT secret validation failed"))
}
}
// Check client-auth CA certificate secret
clientAuthCASecretName = spec.Sync.Authentication.GetClientCASecretName()
err = k8sutil.RunWithTimeout(ctx, func(ctxChild context.Context) error {
return k8sutil.ValidateCACertificateSecret(ctxChild, cachedStatus.SecretReadInterface(), clientAuthCASecretName)
})
if err != nil {
return nil, errors.WithStack(errors.Wrapf(err, "Client authentication CA certificate secret validation failed"))
}
}

podCreator = &MemberSyncPod{
tlsKeyfileSecretName: tlsKeyfileSecretName,
clientAuthCASecretName: clientAuthCASecretName,
masterJWTSecretName: masterJWTSecretName,
clusterJWTSecretName: clusterJWTSecretName,
groupSpec: groupSpec,
spec: spec,
group: group,
resources: r,
imageInfo: imageInfo,
arangoMember: *member,
apiObject: apiObject,
memberStatus: *newMember,
groupSpec: groupSpec,
spec: spec,
group: group,
resources: r,
imageInfo: imageInfo,
arangoMember: *member,
apiObject: apiObject,
memberStatus: *newMember,
}
} else {
return nil, errors.Newf("unable to render Pod")
}

pod, err := RenderArangoPod(cachedStatus, apiObject, role, newMember.ID, newMember.PodName, podCreator)
pod, err := RenderArangoPod(ctx, cachedStatus, apiObject, role, newMember.ID, newMember.PodName, podCreator)
if err != nil {
return nil, err
}
Expand Down Expand Up @@ -625,10 +574,15 @@ func (r *Resources) createPodForMember(ctx context.Context, cachedStatus inspect
}

// RenderArangoPod renders new ArangoD Pod
func RenderArangoPod(cachedStatus inspectorInterface.Inspector, deployment k8sutil.APIObject, role, id, podName string,
podCreator interfaces.PodCreator) (*core.Pod, error) {
func RenderArangoPod(ctx context.Context, cachedStatus inspectorInterface.Inspector, deployment k8sutil.APIObject,
role, id, podName string, podCreator interfaces.PodCreator) (*core.Pod, error) {

// Validate if the pod can be created.
if err := podCreator.Validate(cachedStatus); err != nil {
return nil, errors.Wrapf(err, "Validation of pods resources failed")
}

// Prepare basic pod
// Prepare basic pod.
p := k8sutil.NewPod(deployment.GetName(), role, id, podName, podCreator)

for k, v := range podCreator.Annotations() {
Expand All @@ -647,7 +601,9 @@ func RenderArangoPod(cachedStatus inspectorInterface.Inspector, deployment k8sut
p.Labels[k] = v
}

podCreator.Init(&p)
if err := podCreator.Init(ctx, cachedStatus, &p); err != nil {
return nil, err
}

if initContainers, err := podCreator.GetInitContainers(cachedStatus); err != nil {
return nil, errors.WithStack(err)
Expand Down
5 changes: 4 additions & 1 deletion pkg/deployment/resources/pod_creator_arangod.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
package resources

import (
"context"
"fmt"
"math"
"os"
Expand Down Expand Up @@ -252,10 +253,12 @@ func (m *MemberArangoDPod) AsInput() pod.Input {
}
}

func (m *MemberArangoDPod) Init(pod *core.Pod) {
func (m *MemberArangoDPod) Init(_ context.Context, _ interfaces.Inspector, pod *core.Pod) error {
terminationGracePeriodSeconds := int64(math.Ceil(m.group.DefaultTerminationGracePeriod().Seconds()))
pod.Spec.TerminationGracePeriodSeconds = &terminationGracePeriodSeconds
pod.Spec.PriorityClassName = m.groupSpec.PriorityClassName

return nil
}

func (m *MemberArangoDPod) Validate(cachedStatus interfaces.Inspector) error {
Expand Down
49 changes: 47 additions & 2 deletions pkg/deployment/resources/pod_creator_sync.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,11 @@
package resources

import (
"context"
"math"

"github.com/arangodb/kube-arangodb/pkg/util/errors"

meta "k8s.io/apimachinery/pkg/apis/meta/v1"

"github.com/arangodb/kube-arangodb/pkg/util/collection"
Expand Down Expand Up @@ -298,13 +301,55 @@ func (m *MemberSyncPod) GetContainerCreator() interfaces.ContainerCreator {
}
}

func (m *MemberSyncPod) Init(pod *core.Pod) {
// Init initializes the arangosync pod.
func (m *MemberSyncPod) Init(ctx context.Context, cachedStatus interfaces.Inspector, pod *core.Pod) error {
terminationGracePeriodSeconds := int64(math.Ceil(m.group.DefaultTerminationGracePeriod().Seconds()))
pod.Spec.TerminationGracePeriodSeconds = &terminationGracePeriodSeconds
pod.Spec.PriorityClassName = m.groupSpec.PriorityClassName

m.masterJWTSecretName = m.spec.Sync.Authentication.GetJWTSecretName()
err := k8sutil.RunWithTimeout(ctx, func(ctxChild context.Context) error {
return k8sutil.ValidateTokenSecret(ctxChild, cachedStatus.SecretReadInterface(), m.masterJWTSecretName)
})
if err != nil {
return errors.Wrapf(err, "Master JWT secret validation failed")
}

monitoringTokenSecretName := m.spec.Sync.Monitoring.GetTokenSecretName()
err = k8sutil.RunWithTimeout(ctx, func(ctxChild context.Context) error {
return k8sutil.ValidateTokenSecret(ctxChild, cachedStatus.SecretReadInterface(), monitoringTokenSecretName)
})
if err != nil {
return errors.Wrapf(err, "Monitoring token secret validation failed")
}

if m.group == api.ServerGroupSyncMasters {
// Create TLS secret
m.tlsKeyfileSecretName = k8sutil.CreateTLSKeyfileSecretName(m.apiObject.GetName(), m.group.AsRole(), m.memberStatus.ID)
// Check cluster JWT secret
if m.spec.IsAuthenticated() {
m.clusterJWTSecretName = m.spec.Authentication.GetJWTSecretName()
err = k8sutil.RunWithTimeout(ctx, func(ctxChild context.Context) error {
return k8sutil.ValidateTokenSecret(ctxChild, cachedStatus.SecretReadInterface(), m.clusterJWTSecretName)
})
if err != nil {
return errors.Wrapf(err, "Cluster JWT secret validation failed")
}
}
// Check client-auth CA certificate secret
m.clientAuthCASecretName = m.spec.Sync.Authentication.GetClientCASecretName()
err = k8sutil.RunWithTimeout(ctx, func(ctxChild context.Context) error {
return k8sutil.ValidateCACertificateSecret(ctxChild, cachedStatus.SecretReadInterface(), m.clientAuthCASecretName)
})
if err != nil {
return errors.Wrapf(err, "Client authentication CA certificate secret validation failed")
}
}

return nil
}

func (m *MemberSyncPod) Validate(cachedStatus interfaces.Inspector) error {
func (m *MemberSyncPod) Validate(_ interfaces.Inspector) error {
return nil
}

Expand Down
4 changes: 3 additions & 1 deletion pkg/util/k8sutil/interfaces/pod_creator.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@
package interfaces

import (
"context"

"github.com/arangodb/kube-arangodb/pkg/util/k8sutil/inspector/secret"
"github.com/arangodb/kube-arangodb/pkg/util/k8sutil/inspector/service"
core "k8s.io/api/core/v1"
Expand All @@ -38,7 +40,7 @@ type PodModifier interface {
}

type PodCreator interface {
Init(*core.Pod)
Init(context.Context, Inspector, *core.Pod) error
GetName() string
GetRole() string
GetVolumes() []core.Volume
Expand Down