keel-hq
/
keel
mirror of https://github.com/keel-hq/keel/tree/master/chart/keel
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

merge

feature/stateful_set
Karolis Rusenas 2018-04-18 07:31:48 +01:00
parent 83de5c83f6 1816497a9c
commit d61707d12a
10 changed files with 390 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
provider/helm/unversioned_updates.go
View File

@ -18,7 +18,7 @@ func checkUnversionedRelease(repo *types.Repository, namespace, name string, cha
Values: make(map[string]string),
}
eventRepoRef, err := image.Parse(repo.Name)
eventRepoRef, err := image.Parse(repo.String())
if err != nil {
log.WithFields(log.Fields{
"error": err,

15
provider/kubernetes/force_update.go
View File

@ -32,16 +32,25 @@ func (p *Provider) forceUpdate(deployment *v1beta1.Deployment) (err error) {
for index, pod := range podList.Items {
var gp int64
if pod.DeletionGracePeriodSeconds != nil {
gp = *pod.DeletionGracePeriodSeconds
}
if gracePeriod != 0 {
gp = gracePeriod
}
log.WithFields(log.Fields{
"selector": selector,
"pod": pod.Name,
"namespace": deployment.Namespace,
"deployment": deployment.Name,
"grace_period": fmt.Sprint(gracePeriod),
"grace_period": fmt.Sprint(gp),
}).Info("provider.kubernetes: deleting pod to force pull...")
err = p.implementer.DeletePod(deployment.Namespace, pod.Name, &meta_v1.DeleteOptions{
GracePeriodSeconds: &gracePeriod,
GracePeriodSeconds: &gp,
})
if err != nil {
log.WithFields(log.Fields{
@ -55,7 +64,7 @@ func (p *Provider) forceUpdate(deployment *v1beta1.Deployment) (err error) {
// sleep between pod restarts but not if there aren't more left
if index < len(podList.Items)-1 {
time.Sleep(time.Duration(podDeleteDelay))
time.Sleep(time.Duration(podDeleteDelay) * time.Second)
}
}

60
provider/kubernetes/force_update_test.go
View File

@ -2,6 +2,7 @@ package kubernetes
import (
"testing"
"time"
"github.com/keel-hq/keel/types"
"k8s.io/api/core/v1"
@ -69,3 +70,62 @@ func TestForceUpdate(t *testing.T) {
t.Errorf("wrong name: %s", fp.deletedPods[1].Name)
}
}
func TestForceUpdateDelay(t *testing.T) {
fp := &fakeImplementer{}
dep := &v1beta1.Deployment{
meta_v1.TypeMeta{},
meta_v1.ObjectMeta{
Name: "deployment-1",
Namespace: "xx",
Labels: map[string]string{types.KeelPolicyLabel: "all"},
Annotations: map[string]string{types.KeelPodDeleteDelay: "300"},
},
v1beta1.DeploymentSpec{},
v1beta1.DeploymentStatus{},
}
fp.podList = &v1.PodList{
Items: []v1.Pod{
v1.Pod{
ObjectMeta: meta_v1.ObjectMeta{
Name: "1",
Namespace: "xx",
},
},
v1.Pod{
ObjectMeta: meta_v1.ObjectMeta{
Name: "2",
Namespace: "xx",
},
},
},
}
provider, err := NewProvider(fp, &fakeSender{}, approver())
if err != nil {
t.Fatalf("failed to get provider: %s", err)
}
go func() {
err = provider.forceUpdate(dep)
if err != nil {
t.Fatalf("failed to force update: %s", err)
}
}()
time.Sleep(100 * time.Millisecond)
if len(fp.deletedPods) != 1 {
t.Errorf("expected to get 1 deleted pods, another one should be delayed")
}
if fp.deletedPods[0].Namespace != "xx" {
t.Errorf("wrong namespace: %s", fp.deletedPods[0].Namespace)
}
if fp.deletedPods[0].Name != "1" {
t.Errorf("wrong name: %s", fp.deletedPods[0].Name)
}
}

18
provider/kubernetes/unversioned_updates.go
View File

@ -14,7 +14,7 @@ import (
func (p *Provider) checkUnversionedDeployment(policy types.PolicyType, repo *types.Repository, resource *k8s.GenericResource) (updatePlan *UpdatePlan, shouldUpdateDeployment bool, err error) {
updatePlan = &UpdatePlan{}
eventRepoRef, err := image.Parse(repo.Name)
eventRepoRef, err := image.Parse(repo.String())
if err != nil {
return
}
@ -70,6 +70,20 @@ func (p *Provider) checkUnversionedDeployment(policy types.PolicyType, repo *typ
}
}
// updating annotations
// annotations := resource.GetAnnotations()
matchTag, ok := annotations[types.KeelForceTagMatchLabel]
if ok {
if matchTag == "true" && containerImageRef.Tag() != eventRepoRef.Tag() {
continue
}
// if deployment.Spec.Template.Annotations == nil {
// deployment.Spec.Template.Annotations = map[string]string{}
// }
// deployment.Spec.Template.Annotations["time"] = timeutil.Now().String()
}
// updating image
if containerImageRef.Registry() == image.DefaultRegistryHostname {
// c.Image = fmt.Sprintf("%s:%s", containerImageRef.ShortName(), repo.Tag)
@ -84,7 +98,7 @@ func (p *Provider) checkUnversionedDeployment(policy types.PolicyType, repo *typ
shouldUpdateDeployment = true
// updating annotations
annotations := resource.GetAnnotations()
// annotations := resource.GetAnnotations()
// updating digest if available
// if repo.Digest != "" {

190
provider/kubernetes/unversioned_updates_test.go
View File

@ -3,16 +3,24 @@ package kubernetes
import (
"reflect"
"testing"
"time"
"github.com/keel-hq/keel/approvals"
"github.com/keel-hq/keel/extension/notification"
"github.com/keel-hq/keel/types"
"github.com/keel-hq/keel/util/timeutil"
"k8s.io/api/core/v1"
"k8s.io/api/extensions/v1beta1"
meta_v1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)
func TestProvider_checkUnversionedDeployment(t *testing.T) {
timeutil.Now = func() time.Time {
return time.Date(0, 0, 0, 0, 0, 0, 0, time.UTC)
}
defer func() { timeutil.Now = time.Now }()
type fields struct {
implementer Implementer
sender notification.Sender
@ -271,6 +279,182 @@ func TestProvider_checkUnversionedDeployment(t *testing.T) {
wantShouldUpdateDeployment: true,
wantErr: false,
},
{
name: "poll trigger, force-match, same tag",
args: args{
policy: types.PolicyTypeForce,
repo: &types.Repository{Name: "karolisr/keel", Tag: "latest-staging"},
deployment: v1beta1.Deployment{
meta_v1.TypeMeta{},
meta_v1.ObjectMeta{
Name: "dep-1",
Namespace: "xxxx",
Labels: map[string]string{types.KeelPolicyLabel: "force"},
Annotations: map[string]string{
types.KeelPollScheduleAnnotation: types.KeelPollDefaultSchedule,
types.KeelForceTagMatchLabel: "yup",
},
},
v1beta1.DeploymentSpec{
Template: v1.PodTemplateSpec{
Spec: v1.PodSpec{
Containers: []v1.Container{
v1.Container{
Image: "karolisr/keel:latest-staging",
},
},
},
},
},
v1beta1.DeploymentStatus{},
},
},
wantUpdatePlan: &UpdatePlan{
Deployment: v1beta1.Deployment{
meta_v1.TypeMeta{},
meta_v1.ObjectMeta{
Name: "dep-1",
Namespace: "xxxx",
Annotations: map[string]string{
types.KeelPollScheduleAnnotation: types.KeelPollDefaultSchedule,
types.KeelForceTagMatchLabel: "yup",
forceUpdateImageAnnotation: "karolisr/keel:latest-staging",
},
Labels: map[string]string{types.KeelPolicyLabel: "force"},
},
v1beta1.DeploymentSpec{
Template: v1.PodTemplateSpec{
ObjectMeta: meta_v1.ObjectMeta{
Annotations: map[string]string{
"time": timeutil.Now().String(),
},
},
Spec: v1.PodSpec{
Containers: []v1.Container{
v1.Container{
Image: "karolisr/keel:latest-staging",
},
},
},
},
},
v1beta1.DeploymentStatus{},
},
NewVersion: "latest-staging",
CurrentVersion: "latest-staging",
},
wantShouldUpdateDeployment: true,
wantErr: false,
},
{
name: "poll trigger, force-match, same tag on eu.gcr.io",
args: args{
policy: types.PolicyTypeForce,
repo: &types.Repository{Host: "eu.gcr.io", Name: "karolisr/keel", Tag: "latest-staging"},
deployment: v1beta1.Deployment{
meta_v1.TypeMeta{},
meta_v1.ObjectMeta{
Name: "dep-1",
Namespace: "xxxx",
Labels: map[string]string{types.KeelPolicyLabel: "force"},
Annotations: map[string]string{
types.KeelPollScheduleAnnotation: types.KeelPollDefaultSchedule,
types.KeelForceTagMatchLabel: "yup",
},
},
v1beta1.DeploymentSpec{
Template: v1.PodTemplateSpec{
ObjectMeta: meta_v1.ObjectMeta{
Annotations: map[string]string{
"this": "that",
},
},
Spec: v1.PodSpec{
Containers: []v1.Container{
v1.Container{
Image: "eu.gcr.io/karolisr/keel:latest-staging",
},
},
},
},
},
v1beta1.DeploymentStatus{},
},
},
wantUpdatePlan: &UpdatePlan{
Deployment: v1beta1.Deployment{
meta_v1.TypeMeta{},
meta_v1.ObjectMeta{
Name: "dep-1",
Namespace: "xxxx",
Annotations: map[string]string{
types.KeelPollScheduleAnnotation: types.KeelPollDefaultSchedule,
types.KeelForceTagMatchLabel: "yup",
forceUpdateImageAnnotation: "eu.gcr.io/karolisr/keel:latest-staging",
},
Labels: map[string]string{types.KeelPolicyLabel: "force"},
},
v1beta1.DeploymentSpec{
Template: v1.PodTemplateSpec{
ObjectMeta: meta_v1.ObjectMeta{
Annotations: map[string]string{
"this": "that",
"time": timeutil.Now().String(),
},
},
Spec: v1.PodSpec{
Containers: []v1.Container{
v1.Container{
Image: "eu.gcr.io/karolisr/keel:latest-staging",
},
},
},
},
},
v1beta1.DeploymentStatus{},
},
NewVersion: "latest-staging",
CurrentVersion: "latest-staging",
},
wantShouldUpdateDeployment: true,
wantErr: false,
},
{
name: "poll trigger, force-match, different tag",
args: args{
policy: types.PolicyTypeForce,
repo: &types.Repository{Name: "karolisr/keel", Tag: "latest-staging"},
deployment: v1beta1.Deployment{
meta_v1.TypeMeta{},
meta_v1.ObjectMeta{
Name: "dep-1",
Namespace: "xxxx",
Annotations: map[string]string{types.KeelPollScheduleAnnotation: types.KeelPollDefaultSchedule},
Labels: map[string]string{types.KeelPolicyLabel: "force"},
},
v1beta1.DeploymentSpec{
Template: v1.PodTemplateSpec{
Spec: v1.PodSpec{
Containers: []v1.Container{
v1.Container{
Image: "karolisr/keel:latest-acceptance",
},
},
},
},
},
v1beta1.DeploymentStatus{},
},
},
wantUpdatePlan: &UpdatePlan{
Deployment: v1beta1.Deployment{},
},
wantShouldUpdateDeployment: false,
wantErr: false,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
@ -283,14 +467,14 @@ func TestProvider_checkUnversionedDeployment(t *testing.T) {
}
gotUpdatePlan, gotShouldUpdateDeployment, err := p.checkUnversionedDeployment(tt.args.policy, tt.args.repo, tt.args.deployment)
if (err != nil) != tt.wantErr {
t.Errorf("Provider.checkUnversionedDeployment() error = %v, wantErr %v", err, tt.wantErr)
t.Errorf("Provider.checkUnversionedDeployment() error = %#v, wantErr %#v", err, tt.wantErr)
return
}
if !reflect.DeepEqual(gotUpdatePlan, tt.wantUpdatePlan) {
t.Errorf("Provider.checkUnversionedDeployment() gotUpdatePlan = %v, want %v", gotUpdatePlan, tt.wantUpdatePlan)
t.Errorf("Provider.checkUnversionedDeployment() gotUpdatePlan = %#v, want %#v", gotUpdatePlan, tt.wantUpdatePlan)
}
if gotShouldUpdateDeployment != tt.wantShouldUpdateDeployment {
t.Errorf("Provider.checkUnversionedDeployment() gotShouldUpdateDeployment = %v, want %v", gotShouldUpdateDeployment, tt.wantShouldUpdateDeployment)
t.Errorf("Provider.checkUnversionedDeployment() gotShouldUpdateDeployment = %#v, want %#v", gotShouldUpdateDeployment, tt.wantShouldUpdateDeployment)
}
})
}

10
readme.md
View File

@ -85,4 +85,12 @@ Before starting to work on some big or medium features - raise an issue [here](h
### Developing Keel
If you wish to work on Keel itself, you will need Go 1.8+ installed. Make sure you put Keel into correct Gopath and `go build` (dependency management is done through [dep](https://github.com/golang/dep)).
If you wish to work on Keel itself, you will need Go 1.9+ installed. Make sure you put Keel into correct Gopath and `go build` (dependency management is done through [dep](https://github.com/golang/dep)).
To test Keel while developing:
1. Launch a Kubernetes cluster like Minikube or Docker for Mac with Kubernetes.
2. Change config to use it: `kubectl config use-context docker-for-desktop`
3. Build Keel from `cmd/keel` directory.
4. Start Keel with: `keel --no-incluster`. This will use Kubeconfig from your home.

46
types/types.go
View File

@ -25,6 +25,8 @@ const KeelPolicyLabel = "keel.sh/policy"
// changes
const KeelTriggerLabel = "keel.sh/trigger"
const KeelForceTagMatchLabel = "keel.sh/match-tag"
// KeelPollScheduleAnnotation - optional variable to setup custom schedule for polling, defaults to @every 10m
const KeelPollScheduleAnnotation = "keel.sh/pollSchedule"
@ -51,6 +53,9 @@ const KeelApprovalDeadlineDefault = 24
// during force deploy
const KeelPodDeleteDelay = "keel.sh/forceDelay"
//KeelPodMaxDelay defines maximum delay in seconds between deleting pods
const KeelPodMaxDelay int64 = 600
// KeelPodTerminationGracePeriod - optional grace period during
// pod termination
const KeelPodTerminationGracePeriod = "keel.sh/gracePeriod"
@ -64,6 +69,20 @@ type Repository struct {
Digest string `json:"digest"` // optional digest field
}
// String gives you [host/]team/repo[:tag] identifier
func (r *Repository) String() string {
b := bytes.NewBufferString(r.Host)
if b.Len() != 0 {
b.WriteRune('/')
}
b.WriteString(r.Name)
if r.Tag != "" {
b.WriteRune(':')
b.WriteString(r.Tag)
}
return b.String()
}
// Event - holds information about new event from trigger
type Event struct {
Repository Repository `json:"repository,omitempty"`
@ -218,19 +237,24 @@ func ParsePodDeleteDelay(annotations map[string]string) int64 {
return delay
}
delayStr, ok := annotations[KeelPodDeleteDelay]
if ok {
g, err := strconv.Atoi(delayStr)
if err != nil {
return delay
}
if g > 0 && g < 600 {
return int64(g)
}
if !ok {
return delay
}
return delay
g, err := strconv.Atoi(delayStr)
if err != nil {
return delay
}
if g < 1 {
return delay
}
if int64(g) > KeelPodMaxDelay {
return KeelPodMaxDelay
}
return int64(g)
}
// ParsePodTerminationGracePeriod - parses pod termination time in seconds

44
types/types_test.go
View File

@ -166,3 +166,47 @@ func TestParseEventNotificationChannels(t *testing.T) {
})
}
}
func TestParsePodDeleteDelay(t *testing.T) {
type args struct {
annotations map[string]string
}
tests := []struct {
name string
args args
want int64
}{
{
name: "not specified",
args: args{map[string]string{}},
want: 0,
},
{
name: "string",
args: args{map[string]string{KeelPodDeleteDelay: "aa"}},
want: 0,
},
{
name: "10",
args: args{map[string]string{KeelPodDeleteDelay: "10"}},
want: 10,
},
{
name: "-10",
args: args{map[string]string{KeelPodDeleteDelay: "-10"}},
want: 0,
},
{
name: "over max",
args: args{map[string]string{KeelPodDeleteDelay: "50000"}},
want: KeelPodMaxDelay,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
if got := ParsePodDeleteDelay(tt.args.annotations); got != tt.want {
t.Errorf("ParsePodDeleteDelay() = %v, want %v", got, tt.want)
}
})
}
}

6
util/timeutil/now.go Normal file
View File

@ -0,0 +1,6 @@
package timeutil
import "time"
//Now utility, to replace for testing
var Now = time.Now

20
util/version/version_test.go
View File

@ -203,6 +203,26 @@ func TestShouldUpdate(t *testing.T) {
want: false,
wantErr: false,
},
{
name: "parsed prerelease patch increase, policy minor, no prerelease",
args: args{
current: MustParse("v1.0.0"),
new: MustParse("v1.0.1-metadata"),
policy: types.PolicyTypeMinor,
},
want: false,
wantErr: false,
},
{
name: "parsed prerelease minor increase, policy minor, both have metadata",
args: args{
current: MustParse("v1.0.0-metadata"),
new: MustParse("v1.0.1-metadata"),
policy: types.PolicyTypeMinor,
},
want: true,
wantErr: false,
},
{
name: "prerelease patch increase, policy minor",
args: args{