Skip to content

fix: correctly handle multiple registries with the same Host #1063

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 2 commits into from
Mar 3, 2025
Merged

fix: correctly handle multiple registries with the same Host #1063

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a1b1224
fix: correctly handle multiple registries with the same Host
dkoshkin Mar 2, 2025
2095834
fixup! refactor: Use sentinel error and lo.Find
jimmidyson Mar 3, 2025
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
82 changes: 71 additions & 11 deletions pkg/handlers/generic/mutation/mirrors/containerd_files.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,14 @@ package mirrors
import (
"bytes"
_ "embed"
"errors"
"fmt"
"net/url"
"path"
"strings"
"text/template"

"github.com/samber/lo"
cabpkv1 "sigs.k8s.io/cluster-api/bootstrap/kubeadm/api/v1beta1"

"github.com/nutanix-cloud-native/cluster-api-runtime-extensions-nutanix/pkg/common"
Expand Down Expand Up @@ -139,21 +141,17 @@ func generateRegistryCACertFiles(

var files []cabpkv1.File //nolint:prealloc // We don't know the size of the slice yet.

for _, config := range configs {
if config.CASecretName == "" {
continue
}

registryCACertPathOnRemote, err := config.filePathFromURL()
if err != nil {
return nil, fmt.Errorf("failed generating CA certificate file path from URL: %w", err)
}
filesToGenerate, err := registryCACertFiles(configs)
if err != nil {
return nil, err
}
for _, file := range filesToGenerate {
files = append(files, cabpkv1.File{
Path: registryCACertPathOnRemote,
Path: file.path,
Permissions: "0600",
ContentFrom: &cabpkv1.FileSource{
Secret: cabpkv1.SecretFileSource{
Name: config.CASecretName,
Name: file.caSecretName,
Key: secretKeyForCACert,
},
},
Expand Down Expand Up @@ -189,3 +187,65 @@ func formatURLForContainerd(uri string) (string, error) {
// using path.Join on all elements incorrectly drops a "/" from "https://"
return fmt.Sprintf("%s/%s", mirror, mirrorPath), nil
}

type containerdConfigFile struct {
path string
url string
caSecretName string
caCert string
}

var ErrConflictingRegistryCACertificates = errors.New(
"conflicting CA certificate specified for registry host",
)

// registryCACertFiles returns a list of CA certificate files
// that should be generated for the given containerd configurations.
// If any of the provided configurations share the same url.Host only a single file will be generated.
// An error will be returned, if the CA certificate content for the same URL.Host do not match.
func registryCACertFiles(configs []containerdConfig) ([]containerdConfigFile, error) {
filesToGenerate := make([]containerdConfigFile, 0, len(configs))

for _, config := range configs {
// Skip if CA certificate is not provided.
if config.CASecretName == "" {
continue
}
registryCACertPathOnRemote, err := config.filePathFromURL()
if err != nil {
return nil, fmt.Errorf("failed generating CA certificate file path from URL: %w", err)
}

existingFileToGenerate, existing := lo.Find(
filesToGenerate,
func(f containerdConfigFile) bool {
return registryCACertPathOnRemote == f.path
},
)
// File exists and needs to be checked for conflicts.
if existing {
if config.CACert != existingFileToGenerate.caCert {
return nil, fmt.Errorf(
"%w: %q (from secrets %q and %q)",
ErrConflictingRegistryCACertificates,
config.URL,
config.CASecretName,
existingFileToGenerate.caSecretName,
)
}

// File already found with matching content - skipping.
continue
}

// File not already found and needs to be generated.
filesToGenerate = append(filesToGenerate, containerdConfigFile{
path: registryCACertPathOnRemote,
url: config.URL,
caSecretName: config.CASecretName,
caCert: config.CACert,
})
}

return filesToGenerate, nil
}
78 changes: 71 additions & 7 deletions pkg/handlers/generic/mutation/mirrors/containerd_files_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,6 @@ func Test_generateContainerdDefaultHostsFile(t *testing.T) {
override_path = true
`,
},
wantErr: nil,
},
{
name: "ECR mirror image registry with a path and no CA certificate",
Expand All @@ -63,7 +62,6 @@ func Test_generateContainerdDefaultHostsFile(t *testing.T) {
override_path = true
`,
},
wantErr: nil,
},
{
name: "Mirror image registry with a CA and an image registry with no CA certificate",
Expand Down Expand Up @@ -91,7 +89,6 @@ func Test_generateContainerdDefaultHostsFile(t *testing.T) {
override_path = true
`,
},
wantErr: nil,
},
{
name: "Mirror image registry with a CA and an image registry with a CA",
Expand Down Expand Up @@ -124,7 +121,6 @@ func Test_generateContainerdDefaultHostsFile(t *testing.T) {
override_path = true
`,
},
wantErr: nil,
},
{
name: "Image registry with a CA",
Expand All @@ -135,8 +131,6 @@ func Test_generateContainerdDefaultHostsFile(t *testing.T) {
},
},
want: nil,

wantErr: nil,
},
}
for idx := range tests {
Expand All @@ -156,6 +150,7 @@ func Test_generateRegistryCACertFiles(t *testing.T) {
name string
configs []containerdConfig
want []cabpkv1.File
wantErr error
}{
{
name: "ECR mirror image registry with no CA certificate",
Expand All @@ -173,8 +168,41 @@ func Test_generateRegistryCACertFiles(t *testing.T) {
{
URL: "https://registry.example.com",
CASecretName: "my-registry-credentials-secret",
CACert: "-----BEGIN CERTIFICATE-----",
Mirror: true,
},
},
want: []cabpkv1.File{
{
Path: "/etc/containerd/certs.d/registry.example.com/ca.crt",
Owner: "",
Permissions: "0600",
Encoding: "",
Append: false,
ContentFrom: &cabpkv1.FileSource{
Secret: cabpkv1.SecretFileSource{
Name: "my-registry-credentials-secret",
Key: "ca.crt",
},
},
},
},
},
{
name: "Mirror image registry and registry with the same CA certificate",
configs: []containerdConfig{
{
URL: "https://registry.example.com/mirror",
CASecretName: "my-registry-credentials-secret",
CACert: "-----BEGIN CERTIFICATE-----",
Mirror: true,
},
{
URL: "https://registry.example.com/library",
CASecretName: "my-registry-credentials-secret",
CACert: "-----BEGIN CERTIFICATE-----",
Mirror: false,
},
},
want: []cabpkv1.File{
{
Expand All @@ -192,13 +220,49 @@ func Test_generateRegistryCACertFiles(t *testing.T) {
},
},
},
{
name: "Mirror image registry and registry with different CA certificates",
configs: []containerdConfig{
{
URL: "https://registry.example.com/mirror",
CASecretName: "my-registry-credentials-secret",
CACert: "-----BEGIN CERTIFICATE-----",
Mirror: true,
},
{
URL: "https://registry.example.com/library",
CASecretName: "my-registry-credentials-secret",
CACert: "-----BEGIN CERTIFICATE----------END CERTIFICATE-----",
Mirror: false,
},
},
wantErr: ErrConflictingRegistryCACertificates,
},
{
name: "Multiple image registries with different CA certificates",
configs: []containerdConfig{
{
URL: "https://registry.example.com/mirror",
CASecretName: "my-registry-credentials-secret",
CACert: "-----BEGIN CERTIFICATE-----",
Mirror: false,
},
{
URL: "https://registry.example.com/library",
CASecretName: "my-registry-credentials-secret",
CACert: "-----BEGIN CERTIFICATE----------END CERTIFICATE-----",
Mirror: false,
},
},
wantErr: ErrConflictingRegistryCACertificates,
},
}
for idx := range tests {
tt := tests[idx]
t.Run(tt.name, func(t *testing.T) {
t.Parallel()
file, err := generateRegistryCACertFiles(tt.configs)
require.NoError(t, err)
require.ErrorIs(t, err, tt.wantErr)
assert.Equal(t, tt.want, file)
})
}
Expand Down