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.

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

CAA: add support to look up imagePullSecrets for pods #2232

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -45,10 +45,6 @@ configMapGenerator:
##TLS_SETTINGS

secretGenerator:
- name: auth-json-secret
namespace: confidential-containers-system
files:
#- auth.json # set - path to auth.json pull credentials file
- name: peer-pods-secret
namespace: confidential-containers-system
# This file should look like this (w/o quotes!):
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,10 +51,6 @@ configMapGenerator:
##TLS_SETTINGS

secretGenerator:
- name: auth-json-secret
namespace: confidential-containers-system
files:
#- auth.json # set - path to auth.json pull credentials file
- name: peer-pods-secret
namespace: confidential-containers-system
# This file should look like this (w/o quotes!):
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,6 @@ configMapGenerator:
##TLS_SETTINGS

secretGenerator:
- name: auth-json-secret
namespace: confidential-containers-system
# files:
#- auth.json # set - path to auth.json pull credentials file
- name: peer-pods-secret
namespace: confidential-containers-system
literals:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,6 @@ configMapGenerator:
##TLS_SETTINGS

secretGenerator:
- name: auth-json-secret
namespace: confidential-containers-system
files:
#- auth.json # set - path to auth.json pull credentials file
- name: peer-pods-secret
namespace: confidential-containers-system
files:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,10 +44,6 @@ configMapGenerator:
##TLS_SETTINGS

secretGenerator:
- name: auth-json-secret
namespace: confidential-containers-system
files:
#- auth.json # set - path to auth.json pull credentials file
- name: peer-pods-secret
namespace: confidential-containers-system
# the below file should be in this format
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,6 @@ configMapGenerator:
##TLS_SETTINGS

secretGenerator:
- name: auth-json-secret
namespace: confidential-containers-system
files:
#- auth.json # set - path to auth.json pull credentials file
- name: peer-pods-secret
namespace: confidential-containers-system
literals:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,6 @@ configMapGenerator:
##TLS_SETTINGS

secretGenerator:
- name: auth-json-secret
namespace: confidential-containers-system
files:
#- auth.json # set - path to auth.json pull credentials file
- name: ssh-key-secret
namespace: confidential-containers-system
files: # key generation example: ssh-keygen -f ./id_rsa -N "" && sudo cat id_rsa.pub >> /root/.ssh/authorized_keys
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,10 +57,6 @@ configMapGenerator:
##TLS_SETTINGS

secretGenerator:
- name: auth-json-secret
namespace: confidential-containers-system
files:
#- auth.json # set - path to auth.json pull credentials file
- name: peer-pods-secret
namespace: confidential-containers-system
literals:
Expand Down
6 changes: 6 additions & 0 deletions src/cloud-api-adaptor/install/rbac/peer-pod.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,12 @@ rules:
- apiGroups: [""]
resources: ["pods"]
verbs: ["get", "list"]
- apiGroups: [""]
resources: ["secrets"]
verbs: ["get", "list"]
- apiGroups: [""]
resources: ["serviceaccounts"]
verbs: ["get", "list"]
---
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRoleBinding
Expand Down
7 changes: 0 additions & 7 deletions src/cloud-api-adaptor/install/yamls/caa-pod.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,6 @@ spec:
periodSeconds: 20
initialDelaySeconds: 20
volumeMounts:
- name: auth-json
mountPath: "/root/containers/" # hardcoded
readOnly: true
- mountPath: /root/.ssh/
name: ssh
readOnly: true
Expand All @@ -73,10 +70,6 @@ spec:
nodeSelector:
node.kubernetes.io/worker: ""
volumes:
- name: auth-json
secret:
secretName: auth-json-secret
optional: true # failing?
- name: ssh
secret:
defaultMode: 384
Expand Down
22 changes: 8 additions & 14 deletions src/cloud-api-adaptor/pkg/adaptor/cloud/cloud.go
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,7 @@ import (
)

const (
SrcAuthfilePath = "/root/containers/auth.json"
Version = "0.0.0"
Version = "0.0.0"
)

type InitData struct {
Expand Down Expand Up @@ -253,18 +252,6 @@ func (s *cloudService) CreateVM(ctx context.Context, req *pb.CreateVMRequest) (r

agentProxy := s.proxyFactory.New(serverName, socketPath)

var authJSON []byte
_, err = os.Stat(SrcAuthfilePath)
if err != nil {
logger.Printf("credential file %s is not present, skipping image auth config", SrcAuthfilePath)
} else {
authJSON, err = os.ReadFile(SrcAuthfilePath)
if err != nil {
return nil, fmt.Errorf("error reading %s: %v", SrcAuthfilePath, err)
}
logger.Printf("configure agent to use credentials file %s", SrcAuthfilePath)
}

daemonConfig := forwarder.Config{
PodNamespace: namespace,
PodName: pod,
Expand Down Expand Up @@ -320,7 +307,14 @@ func (s *cloudService) CreateVM(ctx context.Context, req *pb.CreateVMRequest) (r
},
}

// Look up image pull secrets for the pod
authJSON, err := k8sops.GetImagePullSecrets(pod, namespace)
if err != nil {
// Ignore errors
logger.Printf("error reading image pull secrets: %w", err)
}
if authJSON != nil {
logger.Printf("successfully retrieved pod image pull secrets for %s/%s", namespace, pod)
if len(authJSON) > cloudinit.DefaultAuthfileLimit {
logger.Printf("Credentials file is too large to be included in cloud-config")
} else {
Expand Down
91 changes: 91 additions & 0 deletions src/cloud-api-adaptor/pkg/adaptor/k8sops/node.go
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,97 @@ func RemoveExtendedResources() error {
return nil
}

// Auths contains Registries with credentials
type Auths struct {
Registries Registries `json:"auths"`
}

// Registries contains credentials for hosts
type Registries map[string]Auth

// Auth contains credentials for a given host
type Auth struct {
Auth string `json:"auth"`
}

// GetImagePullSecrets gets image pull secrets for the specified pod
func GetImagePullSecrets(podName string, namespace string) ([]byte, error) {

config, err := getKubeConfig()
if err != nil {
return nil, fmt.Errorf("failed to get k8s config: %v", err)
}

cli, err := getClient(config)
if err != nil {
return nil, fmt.Errorf("failed to get k8s client: %v", err)
}

pod, err := cli.CoreV1().Pods(namespace).Get(context.TODO(), podName, metav1.GetOptions{})
if err != nil {
return nil, err
}

accountName := pod.Spec.ServiceAccountName
if accountName == "" {
accountName = "default"
}
serviceaAccount, err := cli.CoreV1().ServiceAccounts(namespace).Get(context.TODO(), accountName, metav1.GetOptions{})
if err != nil {
return nil, err
}

auths := Auths{}
auths.Registries = make(map[string]Auth)
for _, secret := range serviceaAccount.ImagePullSecrets {
err := getAuths(cli, namespace, secret.Name, &auths)
if err != nil {
return nil, err
}
}
for _, secret := range pod.Spec.ImagePullSecrets {
err := getAuths(cli, namespace, secret.Name, &auths)
if err != nil {
return nil, err
}
}

if len(auths.Registries) > 0 {
authJSON, err := json.Marshal(auths)
if err != nil {
return nil, err
}
return authJSON, nil
}
return nil, nil
}

// getAuths get auth credentials from specified docker secret
func getAuths(cli *k8sclient.Clientset, namespace string, secretName string, auths *Auths) error {
secret, err := cli.CoreV1().Secrets(namespace).Get(context.TODO(), secretName, metav1.GetOptions{})
if err != nil {
return err
}
registries := Registries{}
if secretData, ok := secret.Data[".dockerconfigjson"]; ok {
auths := Auths{}
err := json.Unmarshal(secretData, &auths)
if err != nil {
return err
}
registries = auths.Registries
} else if secretData, ok := secret.Data[".dockercfg"]; ok {
err = json.Unmarshal(secretData, &registries)
if err != nil {
return err
}
}
for registry, creds := range registries {
auths.Registries[registry] = creds
}
return nil
}

// patchNodeStatus patches the status of a node
func patchNodeStatus(c *k8sclient.Clientset, nodeName string, patches []jsonPatch) error {
if len(patches) > 0 {
Expand Down
17 changes: 10 additions & 7 deletions src/cloud-api-adaptor/test/e2e/assessment_runner.go
Original file line number Diff line number Diff line change
Expand Up @@ -186,13 +186,16 @@ func writeAuthSecret(client klient.Client, ctx context.Context) error {
return nil
}

providerName := os.Getenv("CLOUD_PROVIDER")
// this path is relative to ./test/e2e
authFilePath := "../../install/overlays/" + providerName + "/auth.json"
authfile, err := os.ReadFile(authFilePath)
if err != nil {
return err
}
template := `{
"auths": {
"%s": {
"auth": "%s"
}
}
}`
cred := os.Getenv("REGISTRY_CREDENTIAL_ENCODED")
registryName := strings.Split(os.Getenv("AUTHENTICATED_REGISTRY_IMAGE"), "/")[0]
authfile := []byte(fmt.Sprintf(template, registryName, cred))

secretData := map[string][]byte{v1.DockerConfigJsonKey: authfile}
secret = NewSecret(E2eNamespace, DEFAULT_AUTH_SECRET, secretData, v1.SecretTypeDockerConfigJson)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -257,10 +257,6 @@ func (lio *DockerInstallOverlay) Edit(ctx context.Context, cfg *envconf.Config,
}
}

if err := lio.Overlay.SetAuthJsonSecretIfApplicable(); err != nil {
return err
}

if err := lio.Overlay.YamlReload(); err != nil {
return err
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -168,10 +168,6 @@ func (lio *IBMCloudInstallOverlay) Edit(ctx context.Context, cfg *envconf.Config
}
}

if err = lio.Overlay.SetAuthJsonSecretIfApplicable(); err != nil {
return err
}

if err = lio.Overlay.YamlReload(); err != nil {
return err
}
Expand Down
22 changes: 0 additions & 22 deletions src/cloud-api-adaptor/test/provisioner/kustomize.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ import (
"context"
"fmt"
"os"
"path/filepath"
"strings"

"golang.org/x/exp/slices"
Expand Down Expand Up @@ -430,24 +429,3 @@ func setSecretGeneratorLiteral(k *ktypes.Kustomization, secretName string, key s

return nil
}

func (kh *KustomizeOverlay) SetAuthJsonSecretIfApplicable() error {
if cred := os.Getenv("REGISTRY_CREDENTIAL_ENCODED"); cred != "" {
registryName := strings.Split(os.Getenv("AUTHENTICATED_REGISTRY_IMAGE"), "/")[0]
template := `{
"auths": {
"%s": {
"auth": "%s"
}
}
}`
authJSON := fmt.Sprintf(template, registryName, cred)
if err := os.WriteFile(filepath.Join(kh.ConfigDir, "auth.json"), []byte(authJSON), 0644); err != nil {
return err
}
if err := kh.SetKustomizeSecretGeneratorFile("auth-json-secret", "auth.json"); err != nil {
return err
}
}
return nil
}
Original file line number Diff line number Diff line change
Expand Up @@ -387,10 +387,6 @@ func (lio *LibvirtInstallOverlay) Edit(ctx context.Context, cfg *envconf.Config,
}
}

if err = lio.Overlay.SetAuthJsonSecretIfApplicable(); err != nil {
return err
}

if err = lio.Overlay.YamlReload(); err != nil {
return err
}
Expand Down