Skip to content

Ignore mount path for git-credentials secrets and mount as file #916

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 1 commit into from
Sep 6, 2022
Merged

Ignore mount path for git-credentials secrets and mount as file #916

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
11 changes: 4 additions & 7 deletions pkg/provision/automount/gitconfig.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ import (
k8sclient "sigs.k8s.io/controller-runtime/pkg/client"
)

const mergedGitCredentialsMountPath = "/.git-credentials/"

// ProvisionGitConfiguration takes care of mounting git credentials and a gitconfig into a devworkspace.
func ProvisionGitConfiguration(api sync.ClusterAPI, namespace string) (*Resources, error) {
credentialsSecrets, tlsConfigMaps, err := getGitResources(api, namespace)
Expand All @@ -45,12 +47,7 @@ func ProvisionGitConfiguration(api sync.ClusterAPI, namespace string) (*Resource
return nil, &AutoMountError{IsFatal: true, Err: err}
}

credentialsMountPath, err := getCredentialsMountPath(credentialsSecrets)
if err != nil {
return nil, &AutoMountError{IsFatal: true, Err: err}
}

gitConfigMap, err := constructGitConfig(namespace, credentialsMountPath, tlsConfigMaps, baseGitConfig)
gitConfigMap, err := constructGitConfig(namespace, mergedGitCredentialsMountPath, tlsConfigMaps, baseGitConfig)
if err != nil {
return nil, &AutoMountError{IsFatal: true, Err: err}
}
Expand Down Expand Up @@ -79,7 +76,7 @@ func ProvisionGitConfiguration(api sync.ClusterAPI, namespace string) (*Resource
return nil, &AutoMountError{IsFatal: false, Err: err}
}
resources := flattenAutomountResources([]Resources{
getAutomountSecret(credentialsMountPath, constants.DevWorkspaceMountAsSubpath, mergedCredentialsSecret),
getAutomountSecret(mergedGitCredentialsMountPath, constants.DevWorkspaceMountAsFile, mergedCredentialsSecret),
getAutomountConfigmap("/etc/", constants.DevWorkspaceMountAsSubpath, gitConfigMap),
})

Expand Down
24 changes: 0 additions & 24 deletions pkg/provision/automount/templates.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,27 +125,3 @@ func mergeGitCredentials(namespace string, credentialSecrets []corev1.Secret) (*
}
return mergedCredentials, nil
}

// getCredentialsMountPath returns the mount path to be used by all git credentials secrets. If no secrets define a mountPath,
// the root path ('/credentials') is used. If secrets define conflicting mountPaths, an error is returned and represents an invalid
// configuration. If any secret defines a mountPath, that mountPath overrides the mountPath for all secrets that do not
// define a mountPath. If there are no credentials secrets, the empty string is returned
func getCredentialsMountPath(secrets []corev1.Secret) (string, error) {
if len(secrets) == 0 {
return "", nil
}
mountPath := ""
for _, secret := range secrets {
secretMountPath := secret.Annotations[constants.DevWorkspaceMountPathAnnotation]
if secretMountPath != "" {
if mountPath != "" && secretMountPath != mountPath {
return "", fmt.Errorf("auto-mounted git credentials have conflicting mountPaths: %s, %s", mountPath, secretMountPath)
}
mountPath = secretMountPath
}
}
if mountPath == "" {
mountPath = "/"
}
return mountPath, nil
}