Skip to content

fix: Correctly configure non-mirror registry certificates #1039

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 3 commits into from
Feb 11, 2025
Merged

fix: Correctly configure non-mirror registry certificates #1039

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
17bc80d
fix: Correctly configure non-mirror registry certificates
jimmidyson Feb 10, 2025
2fd79d3
fixup! refactor: Fix up godoc for generateContainerdDefaultHostsFile
jimmidyson Feb 10, 2025
7bc9094
fixup! revert: Keep old mirrors handler
jimmidyson Feb 11, 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
26 changes: 8 additions & 18 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 @@ -26,7 +26,7 @@ var (
//go:embed templates/hosts.toml.gotmpl
containerdHostsConfiguration []byte

containerdHostsConfigurationTemplate = template.Must(
containerdDefaultHostsConfigurationTemplate = template.Must(
template.New("").Parse(string(containerdHostsConfiguration)),
)

Expand All @@ -36,7 +36,7 @@ var (
"registry-config.toml",
)

mirrorCACertPathOnRemoteFmt = "/etc/certs/%s.pem"
caCertPathOnRemoteFmt = "/etc/containerd/certs.d/%s/ca.crt"
)

type containerdConfig struct {
Expand All @@ -54,14 +54,7 @@ func (c containerdConfig) filePathFromURL() (string, error) {
return "", fmt.Errorf("failed parsing registry URL: %w", err)
}

registryHostWithPath := registryURL.Host
if registryURL.Path != "" {
registryHostWithPath = path.Join(registryURL.Host, registryURL.Path)
}

replaced := strings.ReplaceAll(registryHostWithPath, "/", "-")

return fmt.Sprintf(mirrorCACertPathOnRemoteFmt, replaced), nil
return fmt.Sprintf(caCertPathOnRemoteFmt, registryURL.Host), nil
}

// Return true if configuration is a mirror or has a CA certificate.
Expand All @@ -76,7 +69,7 @@ func (c containerdConfig) needContainerdConfiguration() bool {
// https://github.com/containerd/containerd/blob/main/docs/hosts.md#setup-default-mirror-for-all-registries
//
// 2. Setting CA certificate for global image registry mirror and image registries.
func generateContainerdHostsFile(
func generateContainerdDefaultHostsFile(
configs []containerdConfig,
) (*cabpkv1.File, error) {
if len(configs) == 0 {
Expand All @@ -86,13 +79,12 @@ func generateContainerdHostsFile(
type templateInput struct {
URL string
CACertPath string
Mirror bool
}

inputs := make([]templateInput, 0, len(configs))

for _, config := range configs {
if !config.needContainerdConfiguration() {
if !config.Mirror {
continue
}

Expand All @@ -102,14 +94,12 @@ func generateContainerdHostsFile(
}

input := templateInput{
URL: formattedURL,
Mirror: config.Mirror,
URL: formattedURL,
}
// CA cert is optional for mirror registry.
// i.e. registry is using signed certificates. Insecure registry will not be allowed.
if config.CACert != "" {
var registryCACertPathOnRemote string
registryCACertPathOnRemote, err = config.filePathFromURL()
registryCACertPathOnRemote, err := config.filePathFromURL()
if err != nil {
return nil, fmt.Errorf(
"failed generating CA certificate file path from URL: %w",
Expand All @@ -123,7 +113,7 @@ func generateContainerdHostsFile(
}

var b bytes.Buffer
err := containerdHostsConfigurationTemplate.Execute(&b, inputs)
err := containerdDefaultHostsConfigurationTemplate.Execute(&b, inputs)
if err != nil {
return nil, fmt.Errorf("failed executing template for Containerd hosts.toml file: %w", err)
}
Expand Down
17 changes: 6 additions & 11 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 @@ -11,7 +11,7 @@ import (
cabpkv1 "sigs.k8s.io/cluster-api/bootstrap/kubeadm/api/v1beta1"
)

func Test_generateContainerdHostsFile(t *testing.T) {
func Test_generateContainerdDefaultHostsFile(t *testing.T) {
t.Parallel()
tests := []struct {
name string
Expand Down Expand Up @@ -85,7 +85,7 @@ func Test_generateContainerdHostsFile(t *testing.T) {
Append: false,
Content: `[host."https://mymirror.com/v2"]
capabilities = ["pull", "resolve"]
ca = "/etc/certs/mymirror.com.pem"
ca = "/etc/containerd/certs.d/mymirror.com/ca.crt"
# don't rely on Containerd to add the v2/ suffix
# there is a bug where it is added incorrectly for mirrors with a path
override_path = true
Expand Down Expand Up @@ -118,14 +118,10 @@ func Test_generateContainerdHostsFile(t *testing.T) {
Append: false,
Content: `[host."https://mymirror.com/v2"]
capabilities = ["pull", "resolve"]
ca = "/etc/certs/mymirror.com.pem"
ca = "/etc/containerd/certs.d/mymirror.com/ca.crt"
# don't rely on Containerd to add the v2/ suffix
# there is a bug where it is added incorrectly for mirrors with a path
override_path = true
[host."https://myregistry.com/v2"]
ca = "/etc/certs/myregistry.com.pem"
[host."https://172.100.0.10:5000/v2/myproject"]
ca = "/etc/certs/172.100.0.10:5000-myproject.pem"
`,
},
wantErr: nil,
Expand All @@ -144,8 +140,7 @@ func Test_generateContainerdHostsFile(t *testing.T) {
Permissions: "0600",
Encoding: "",
Append: false,
Content: `[host."https://myregistry.com/v2"]
ca = "/etc/certs/myregistry.com.pem"
Content: `
`,
},
wantErr: nil,
Expand All @@ -155,7 +150,7 @@ func Test_generateContainerdHostsFile(t *testing.T) {
tt := tests[idx]
t.Run(tt.name, func(t *testing.T) {
t.Parallel()
file, err := generateContainerdHostsFile(tt.configs)
file, err := generateContainerdDefaultHostsFile(tt.configs)
require.ErrorIs(t, err, tt.wantErr)
assert.Equal(t, tt.want, file)
})
Expand Down Expand Up @@ -190,7 +185,7 @@ func Test_generateRegistryCACertFiles(t *testing.T) {
},
want: []cabpkv1.File{
{
Path: "/etc/certs/registry.example.com.pem",
Path: "/etc/containerd/certs.d/registry.example.com/ca.crt",
Owner: "",
Permissions: "0600",
Encoding: "",
Expand Down
2 changes: 1 addition & 1 deletion pkg/handlers/generic/mutation/mirrors/inject.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -239,7 +239,7 @@ func generateFiles(
) ([]bootstrapv1.File, error) {
var files []bootstrapv1.File
// generate default registry mirror file
containerdHostsFile, err := generateContainerdHostsFile(registriesWithOptionalCA)
containerdHostsFile, err := generateContainerdDefaultHostsFile(registriesWithOptionalCA)
if err != nil {
return nil, err
}
Expand Down
10 changes: 5 additions & 5 deletions pkg/handlers/generic/mutation/mirrors/inject_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ var _ = Describe("Generate Global mirror patches", func() {
"path", "/etc/containerd/certs.d/_default/hosts.toml",
),
gomega.HaveKeyWithValue(
"path", "/etc/certs/registry.example.com.pem",
"path", "/etc/containerd/certs.d/registry.example.com/ca.crt",
),
gomega.HaveKeyWithValue(
"path", "/etc/caren/containerd/patches/registry-config.toml",
Expand Down Expand Up @@ -166,7 +166,7 @@ var _ = Describe("Generate Global mirror patches", func() {
"path", "/etc/containerd/certs.d/_default/hosts.toml",
),
gomega.HaveKeyWithValue(
"path", "/etc/certs/registry.example.com.pem",
"path", "/etc/containerd/certs.d/registry.example.com/ca.crt",
),
gomega.HaveKeyWithValue(
"path", "/etc/caren/containerd/patches/registry-config.toml",
Expand Down Expand Up @@ -244,7 +244,7 @@ var _ = Describe("Generate Global mirror patches", func() {
"path", "/etc/containerd/certs.d/_default/hosts.toml",
),
gomega.HaveKeyWithValue(
"path", "/etc/certs/registry.example.com.pem",
"path", "/etc/containerd/certs.d/registry.example.com/ca.crt",
),
gomega.HaveKeyWithValue(
"path", "/etc/caren/containerd/patches/registry-config.toml",
Expand Down Expand Up @@ -299,7 +299,7 @@ var _ = Describe("Generate Global mirror patches", func() {
capitest.VariableWithValue(
v1alpha1.ClusterConfigVariableName,
[]v1alpha1.ImageRegistry{{
URL: "https://registry.example.com",
URL: "https://registry.example.com:5050",
Credentials: &v1alpha1.RegistryCredentials{
SecretRef: &v1alpha1.LocalObjectReference{
Name: validMirrorCASecretName,
Expand Down Expand Up @@ -327,7 +327,7 @@ var _ = Describe("Generate Global mirror patches", func() {
"path", "/etc/containerd/certs.d/_default/hosts.toml",
),
gomega.HaveKeyWithValue(
"path", "/etc/certs/registry.example.com.pem",
"path", "/etc/containerd/certs.d/registry.example.com:5050/ca.crt",
),
gomega.HaveKeyWithValue(
"path", "/etc/caren/containerd/patches/registry-config.toml",
Expand Down
5 changes: 0 additions & 5 deletions pkg/handlers/generic/mutation/mirrors/templates/hosts.toml.gotmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
{{- range . }}
{{- if .Mirror }}
[host."{{ .URL }}"]
capabilities = ["pull", "resolve"]
{{- if .CACertPath }}
Expand All @@ -8,8 +7,4 @@
# don't rely on Containerd to add the v2/ suffix
# there is a bug where it is added incorrectly for mirrors with a path
override_path = true
{{- else }}
[host."{{ .URL }}"]
ca = "{{ .CACertPath }}"
{{- end }}
{{- end }}
Loading