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

[installer] Add custom CA secret support #9082

Merged
merged 1 commit into from
Apr 11, 2022
Merged

[installer] Add custom CA secret support #9082

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: 38 additions & 0 deletions install/installer/pkg/common/ca.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,3 +64,41 @@ func InternalCAContainer(ctx *RenderContext, mod ...func(*corev1.Container)) *co

return res
}

// CustomCACertVolume produces the objects required to mount custom CA certificates
func CustomCACertVolume(ctx *RenderContext) (vol *corev1.Volume, mnt *corev1.VolumeMount, env *corev1.EnvVar, ok bool) {
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: Would it make sense to have the return values in a wrapper struct

if ctx.Config.CustomCACert == nil {
return nil, nil, nil, false
}

const (
volumeName = "custom-ca-cert"
mountPath = "/etc/ssl/certs/custom-ca.crt"
)
vol = &corev1.Volume{
Name: volumeName,
VolumeSource: corev1.VolumeSource{
Secret: &corev1.SecretVolumeSource{
SecretName: ctx.Config.CustomCACert.Name,
Items: []corev1.KeyToPath{
{
Key: "ca.crt",
Path: "ca.crt",
},
},
},
},
}
mnt = &corev1.VolumeMount{
Name: volumeName,
ReadOnly: true,
MountPath: mountPath,
SubPath: "ca.crt",
}
env = &corev1.EnvVar{
Name: "NODE_EXTRA_CA_CERTS",
Value: mountPath,
}
ok = true
return
}
100 changes: 54 additions & 46 deletions install/installer/pkg/components/image-builder-mk3/deployment.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ package image_builder_mk3

import (
"fmt"

"github.com/gitpod-io/gitpod/installer/pkg/cluster"

"github.com/gitpod-io/gitpod/installer/pkg/common"
Expand Down Expand Up @@ -58,6 +59,57 @@ func deployment(ctx *common.RenderContext) ([]runtime.Object, error) {
return nil, err
}

volumes := []corev1.Volume{
{
Name: "configuration",
VolumeSource: corev1.VolumeSource{
ConfigMap: &corev1.ConfigMapVolumeSource{
LocalObjectReference: corev1.LocalObjectReference{Name: fmt.Sprintf("%s-config", Component)},
},
},
},
{
Name: "wsman-tls-certs",
VolumeSource: corev1.VolumeSource{
Secret: &corev1.SecretVolumeSource{
SecretName: wsmanager.TLSSecretNameClient,
},
},
},
{
Name: "pull-secret",
VolumeSource: corev1.VolumeSource{
Secret: &corev1.SecretVolumeSource{
SecretName: secretName,
},
},
},
*common.InternalCAVolume(),
*common.NewEmptyDirVolume("cacerts"),
}
volumeMounts := []corev1.VolumeMount{
{
Name: "configuration",
MountPath: "/config/image-builder.json",
SubPath: "image-builder.json",
},
{
Name: "wsman-tls-certs",
MountPath: "/wsman-certs",
ReadOnly: true,
},
{
Name: "pull-secret",
MountPath: PullSecretFile,
SubPath: ".dockerconfigjson",
},
*common.InternalCAVolumeMount(),
}
if vol, mnt, _, ok := common.CustomCACertVolume(ctx); ok {
volumes = append(volumes, *vol)
volumeMounts = append(volumeMounts, *mnt)
}

return []runtime.Object{&appsv1.Deployment{
TypeMeta: common.TypeMetaDeployment,
ObjectMeta: metav1.ObjectMeta{
Expand Down Expand Up @@ -85,34 +137,7 @@ func deployment(ctx *common.RenderContext) ([]runtime.Object, error) {
DNSPolicy: "ClusterFirst",
RestartPolicy: "Always",
TerminationGracePeriodSeconds: pointer.Int64(30),
Volumes: append([]corev1.Volume{
{
Name: "configuration",
VolumeSource: corev1.VolumeSource{
ConfigMap: &corev1.ConfigMapVolumeSource{
LocalObjectReference: corev1.LocalObjectReference{Name: fmt.Sprintf("%s-config", Component)},
},
},
},
{
Name: "wsman-tls-certs",
VolumeSource: corev1.VolumeSource{
Secret: &corev1.SecretVolumeSource{
SecretName: wsmanager.TLSSecretNameClient,
},
},
},
{
Name: "pull-secret",
VolumeSource: corev1.VolumeSource{
Secret: &corev1.SecretVolumeSource{
SecretName: secretName,
},
},
},
*common.InternalCAVolume(),
*common.NewEmptyDirVolume("cacerts"),
}),
Volumes: volumes,
InitContainers: []corev1.Container{
*common.InternalCAContainer(ctx),
},
Expand Down Expand Up @@ -143,24 +168,7 @@ func deployment(ctx *common.RenderContext) ([]runtime.Object, error) {
Privileged: pointer.Bool(false),
RunAsUser: pointer.Int64(33333),
},
VolumeMounts: []corev1.VolumeMount{
{
Name: "configuration",
MountPath: "/config/image-builder.json",
SubPath: "image-builder.json",
},
{
Name: "wsman-tls-certs",
MountPath: "/wsman-certs",
ReadOnly: true,
},
{
Name: "pull-secret",
MountPath: PullSecretFile,
SubPath: ".dockerconfigjson",
},
*common.InternalCAVolumeMount(),
},
VolumeMounts: volumeMounts,
},
*common.KubeRBACProxyContainer(ctx),
},
Expand Down
104 changes: 56 additions & 48 deletions install/installer/pkg/components/server/deployment.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,55 @@ func deployment(ctx *common.RenderContext) ([]runtime.Object, error) {
}
wsmanCfgManager := base64.StdEncoding.EncodeToString(fc)

env := common.MergeEnv(
common.DefaultEnv(&ctx.Config),
common.DatabaseEnv(&ctx.Config),
common.TracingEnv(ctx),
common.AnalyticsEnv(&ctx.Config),
common.MessageBusEnv(&ctx.Config),
[]corev1.EnvVar{
{
Name: "CONFIG_PATH",
Value: "/config/config.json",
},
func() corev1.EnvVar {
envvar := corev1.EnvVar{
Name: "GITPOD_LICENSE_TYPE",
}

if ctx.Config.License == nil {
envvar.Value = string(configv1.LicensorTypeGitpod)
} else {
envvar.ValueFrom = &corev1.EnvVarSource{
SecretKeyRef: &corev1.SecretKeySelector{
LocalObjectReference: corev1.LocalObjectReference{Name: ctx.Config.License.Name},
Key: "type",
Optional: pointer.Bool(true),
},
}
}

return envvar
}(),
{
Name: "IDE_CONFIG_PATH",
Value: "/ide-config/config.json",
},
{
Name: "NODE_ENV",
Value: "production", // todo(sje): will we need to change this?
},
{
Name: "SHLVL",
Value: "1",
},
{
Name: "WSMAN_CFG_MANAGERS",
Value: wsmanCfgManager,
},
},
)

volumes := make([]corev1.Volume, 0)
volumeMounts := make([]corev1.VolumeMount, 0)
if ctx.Config.License != nil {
Expand Down Expand Up @@ -108,6 +157,12 @@ func deployment(ctx *common.RenderContext) ([]runtime.Object, error) {
}
}

if vol, mnt, envv, ok := common.CustomCACertVolume(ctx); ok {
volumes = append(volumes, *vol)
volumeMounts = append(volumeMounts, *mnt)
env = append(env, *envv)
}

return []runtime.Object{
&appsv1.Deployment{
TypeMeta: common.TypeMetaDeployment,
Expand Down Expand Up @@ -189,54 +244,7 @@ func deployment(ctx *common.RenderContext) ([]runtime.Object, error) {
ContainerPort: PrometheusPort,
}},
// todo(sje): do we need to cater for serverContainer.env from values.yaml?
Env: common.MergeEnv(
common.DefaultEnv(&ctx.Config),
common.DatabaseEnv(&ctx.Config),
common.TracingEnv(ctx),
common.AnalyticsEnv(&ctx.Config),
common.MessageBusEnv(&ctx.Config),
[]corev1.EnvVar{
{
Name: "CONFIG_PATH",
Value: "/config/config.json",
},
func() corev1.EnvVar {
envvar := corev1.EnvVar{
Name: "GITPOD_LICENSE_TYPE",
}

if ctx.Config.License == nil {
envvar.Value = string(configv1.LicensorTypeGitpod)
} else {
envvar.ValueFrom = &corev1.EnvVarSource{
SecretKeyRef: &corev1.SecretKeySelector{
LocalObjectReference: corev1.LocalObjectReference{Name: ctx.Config.License.Name},
Key: "type",
Optional: pointer.Bool(true),
},
}
}

return envvar
}(),
{
Name: "IDE_CONFIG_PATH",
Value: "/ide-config/config.json",
},
{
Name: "NODE_ENV",
Value: "production", // todo(sje): will we need to change this?
},
{
Name: "SHLVL",
Value: "1",
},
{
Name: "WSMAN_CFG_MANAGERS",
Value: wsmanCfgManager,
},
},
),
Env: env,
// todo(sje): conditionally add github-app-cert-secret in
// todo(sje): do we need to cater for serverContainer.volumeMounts from values.yaml?
VolumeMounts: append(
Expand Down
7 changes: 7 additions & 0 deletions install/installer/pkg/components/ws-daemon/daemonset.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -340,6 +340,13 @@ fi
return nil, err
}

if vol, mnt, _, ok := common.CustomCACertVolume(ctx); ok {
podSpec.Volumes = append(podSpec.Volumes, *vol)
pod := podSpec.Containers[0]
pod.VolumeMounts = append(pod.VolumeMounts, *mnt)
podSpec.Containers[0] = pod
}

return []runtime.Object{&appsv1.DaemonSet{
TypeMeta: common.TypeMetaDaemonset,
ObjectMeta: metav1.ObjectMeta{
Expand Down
2 changes: 2 additions & 0 deletions install/installer/pkg/config/v1/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,8 @@ type Config struct {

DisableDefinitelyGP bool `json:"disableDefinitelyGp"`

CustomCACert *ObjectRef `json:"customCACert,omitempty"`

Experimental *experimental.Config `json:"experimental,omitempty"`
}

Expand Down
4 changes: 4 additions & 0 deletions install/installer/pkg/config/v1/validation.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,6 +211,10 @@ func (v version) ClusterValidation(rcfg interface{}) cluster.ValidationChecks {
})))
}

if cfg.CustomCACert != nil {
res = append(res, cluster.CheckSecret(cfg.CustomCACert.Name, cluster.CheckSecretRequiredData("ca.crt")))
}

res = append(res, experimental.ClusterValidation(cfg.Experimental)...)

return res
Expand Down