Skip to content

[installer] Refactor generation of templates configmap #9868

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

Closed
wants to merge 1 commit into from
Closed

[installer] Refactor generation of templates configmap #9868

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
38 changes: 23 additions & 15 deletions install/installer/pkg/components/ws-manager/configmap.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ package wsmanager
import (
"fmt"
"path/filepath"
"strings"
"time"

wsdaemon "github.com/gitpod-io/gitpod/installer/pkg/components/ws-daemon"
Expand Down Expand Up @@ -89,6 +90,7 @@ func configmap(ctx *common.RenderContext) ([]runtime.Object, error) {
if err != nil {
return err
}

classes[k] = &config.WorkspaceClass{
Container: config.ContainerConfiguration{
Requests: &config.ResourceConfiguration{
Expand All @@ -105,7 +107,10 @@ func configmap(ctx *common.RenderContext) ([]runtime.Object, error) {
Templates: tplsCfg,
PVC: config.PVCConfiguration(c.PVC),
}
tpls = append(tpls, ctpls...)

for k, v := range ctpls {
tpls[fixTemplateClass(k)] = v
}
}
return nil
})
Expand Down Expand Up @@ -210,12 +215,21 @@ func configmap(ctx *common.RenderContext) ([]runtime.Object, error) {
"config.json": string(fc),
},
},
&corev1.ConfigMap{
TypeMeta: common.TypeMetaConfigmap,
ObjectMeta: metav1.ObjectMeta{
Name: WorkspaceTemplateConfigMap,
Namespace: ctx.Namespace,
Labels: common.DefaultLabels(Component),
},
Data: tpls,
},
}
res = append(res, tpls...)

return res, nil
}

func buildWorkspaceTemplates(ctx *common.RenderContext, cfgTpls *configv1.WorkspaceTemplates, className string) (config.WorkspacePodTemplateConfiguration, []runtime.Object, error) {
func buildWorkspaceTemplates(ctx *common.RenderContext, cfgTpls *configv1.WorkspaceTemplates, className string) (config.WorkspacePodTemplateConfiguration, map[string]string, error) {
var (
cfg config.WorkspacePodTemplateConfiguration
tpls = make(map[string]string)
Expand Down Expand Up @@ -243,19 +257,13 @@ func buildWorkspaceTemplates(ctx *common.RenderContext, cfgTpls *configv1.Worksp
return cfg, nil, fmt.Errorf("unable to marshal %s workspace template: %w", op.Name, err)
}
fn := filepath.Join(className, op.Name+".yaml")
*op.Path = filepath.Join(WorkspaceTemplatePath, fn)
*op.Path = filepath.Join(WorkspaceTemplatePath, fixTemplateClass(fn))
tpls[fn] = string(fc)
}

return cfg, []runtime.Object{
&corev1.ConfigMap{
TypeMeta: common.TypeMetaConfigmap,
ObjectMeta: metav1.ObjectMeta{
Name: WorkspaceTemplateConfigMap,
Namespace: ctx.Namespace,
Labels: common.DefaultLabels(Component),
},
Data: tpls,
},
}, nil
return cfg, tpls, nil
}

func fixTemplateClass(input string) string {
return strings.ReplaceAll(input, "/", "-")
}
38 changes: 15 additions & 23 deletions install/installer/pkg/components/ws-manager/configmap_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ import (
"github.com/google/go-cmp/cmp"

corev1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/utils/pointer"
)

Expand All @@ -29,13 +28,17 @@ func TestBuildWorkspaceTemplates(t *testing.T) {
Expectation Expectation
}{
{
Name: "no templates",
Expectation: Expectation{},
Name: "no templates",
Expectation: Expectation{
Data: map[string]bool{},
},
},
{
Name: "empty templates",
Config: &configv1.WorkspaceTemplates{},
Expectation: Expectation{},
Name: "empty templates",
Config: &configv1.WorkspaceTemplates{},
Expectation: Expectation{
Data: map[string]bool{},
},
},
{
Name: "default tpl",
Expand Down Expand Up @@ -95,37 +98,26 @@ func TestBuildWorkspaceTemplates(t *testing.T) {
t.Run(test.Name, func(t *testing.T) {
var (
act Expectation
objs []runtime.Object
data map[string]string
err error
)

if test.ContainerRegistry == nil {
test.ContainerRegistry = &configv1.ContainerRegistry{InCluster: pointer.Bool(true)}
}

act.TplConfig, objs, err = buildWorkspaceTemplates(&common.RenderContext{Config: configv1.Config{
act.TplConfig, data, err = buildWorkspaceTemplates(&common.RenderContext{Config: configv1.Config{
ContainerRegistry: *test.ContainerRegistry,
}}, test.Config, "")
if err != nil {
t.Error(err)
}
if len(objs) < 1 {
t.Fatalf("received zero runtime objects")
return
}

cfgmap, ok := objs[0].(*corev1.ConfigMap)
if !ok {
t.Fatalf("buildWorkspaceTemplates did not return a configMap")
return
}
if len(cfgmap.Data) > 0 {
dt := make(map[string]bool)
for k := range cfgmap.Data {
dt[k] = true
}
act.Data = dt
dt := make(map[string]bool)
for k := range data {
dt[k] = true
}
act.Data = dt

if diff := cmp.Diff(test.Expectation, act); diff != "" {
t.Errorf("Expectation mismatch (-want +got):\n%s", diff)
Expand Down