Skip to content

feat: containerd configuration for mirror registry #292

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

Merged
merged 12 commits into from
Feb 6, 2024
Merged
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
112 changes: 72 additions & 40 deletions api/v1alpha1/clusterconfig_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import (

corev1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/utils/ptr"
clusterv1 "sigs.k8s.io/cluster-api/api/v1beta1"

"github.com/d2iq-labs/capi-runtime-extensions/common/pkg/openapi/patterns"
Expand Down Expand Up @@ -89,6 +90,9 @@ type GenericClusterConfig struct {
// +optional
ImageRegistries ImageRegistries `json:"imageRegistries,omitempty"`

// +optional
GlobalImageRegistryMirror *GlobalImageRegistryMirror `json:"globalImageRegistryMirror,omitempty"`

// +optional
Addons *Addons `json:"addons,omitempty"`
}
Expand All @@ -107,7 +111,8 @@ func (s GenericClusterConfig) VariableSchema() clusterv1.VariableSchema { //noli
"",
).VariableSchema().
OpenAPIV3Schema,
"imageRegistries": ImageRegistries{}.VariableSchema().OpenAPIV3Schema,
"imageRegistries": ImageRegistries{}.VariableSchema().OpenAPIV3Schema,
"globalImageRegistryMirror": GlobalImageRegistryMirror{}.VariableSchema().OpenAPIV3Schema,
},
},
}
Expand Down Expand Up @@ -237,84 +242,111 @@ func (ExtraAPIServerCertSANs) VariableSchema() clusterv1.VariableSchema {
}
}

type ImageRegistries struct {
type RegistryCredentials struct {
// The Secret containing the registry credentials and optional CA certificate
// using the keys `username`, `password` and `ca.crt`.
// This credentials Secret is not required for some registries, e.g. ECR.
// +optional
ImageRegistryCredentials ImageRegistryCredentials `json:"credentials,omitempty"`
SecretRef *corev1.ObjectReference `json:"secretRef,omitempty"`
}

func (ImageRegistries) VariableSchema() clusterv1.VariableSchema {
func (RegistryCredentials) VariableSchema() clusterv1.VariableSchema {
return clusterv1.VariableSchema{
OpenAPIV3Schema: clusterv1.JSONSchemaProps{
Description: "Configuration for image registries.",
Type: "object",
Type: "object",
Properties: map[string]clusterv1.JSONSchemaProps{
"credentials": ImageRegistryCredentials{}.VariableSchema().OpenAPIV3Schema,
"secretRef": {
Description: "A reference to the Secret containing the registry credentials. " +
"The Secret should have keys 'username', 'password' and optional 'ca.crt'. " +
"This credentials Secret is not required for some registries, e.g. ECR.",
Type: "object",
Properties: map[string]clusterv1.JSONSchemaProps{
"name": {
Description: "The name of the Secret containing the registry credentials.",
Type: "string",
},
"namespace": {
Description: "The namespace of the Secret containing the registry credentials. " +
"Defaults to the namespace of the Cluster. " +
"that reference this variable.",
Type: "string",
},
},
Required: []string{"name"},
},
},
},
}
}

type ImageRegistryCredentials []ImageRegistryCredentialsResource
// GlobalImageRegistryMirror sets default mirror configuration for all the image registries.
type GlobalImageRegistryMirror struct {
// Registry URL.
URL string `json:"url"`

func (ImageRegistryCredentials) VariableSchema() clusterv1.VariableSchema {
resourceSchema := ImageRegistryCredentialsResource{}.VariableSchema().OpenAPIV3Schema
// Credentials and CA certificate for the image registry mirror
// +optional
Credentials *RegistryCredentials `json:"credentials,omitempty"`
}

func (GlobalImageRegistryMirror) VariableSchema() clusterv1.VariableSchema {
return clusterv1.VariableSchema{
OpenAPIV3Schema: clusterv1.JSONSchemaProps{
Description: "Image registry credentials to set up on all Nodes in the cluster. " +
"Enabling this will configure the Kubelets with " +
"https://kubernetes.io/docs/tasks/administer-cluster/kubelet-credential-provider/.",
Type: "array",
Items: &resourceSchema,
Type: "object",
Properties: map[string]clusterv1.JSONSchemaProps{
"url": {
Description: "Registry mirror URL.",
Type: "string",
Format: "uri",
Pattern: "^https?://",
},
"credentials": RegistryCredentials{}.VariableSchema().OpenAPIV3Schema,
},
Required: []string{"url"},
},
}
}

// ImageRegistryCredentialsResource required for providing credentials for an image registry URL.
type ImageRegistryCredentialsResource struct {
type ImageRegistry struct {
// Registry URL.
URL string `json:"url"`

// The Secret containing the registry credentials.
// The Secret should have keys 'username' and 'password'.
// This credentials Secret is not required for some registries, e.g. ECR.
// Credentials and CA certificate for the image registry
// +optional
Secret *corev1.ObjectReference `json:"secretRef,omitempty"`
Credentials *RegistryCredentials `json:"credentials,omitempty"`
}

func (ImageRegistryCredentialsResource) VariableSchema() clusterv1.VariableSchema {
func (ImageRegistry) VariableSchema() clusterv1.VariableSchema {
return clusterv1.VariableSchema{
OpenAPIV3Schema: clusterv1.JSONSchemaProps{
Type: "object",
Properties: map[string]clusterv1.JSONSchemaProps{
"url": {
Description: "Registry URL.",
Type: "string",
Format: "uri",
Pattern: "^https?://",
},
"secretRef": {
Description: "The Secret containing the registry credentials. " +
"The Secret should have keys 'username' and 'password'. " +
"This credentials Secret is not required for some registries, e.g. ECR.",
Type: "object",
Properties: map[string]clusterv1.JSONSchemaProps{
"name": {
Description: "The name of the Secret containing the registry credentials.",
Type: "string",
},
"namespace": {
Description: "The namespace of the Secret containing the registry credentials. " +
"Defaults to the namespace of the KubeadmControlPlaneTemplate and KubeadmConfigTemplate" +
" that reference this variable.",
Type: "string",
},
},
},
"credentials": RegistryCredentials{}.VariableSchema().OpenAPIV3Schema,
},
Required: []string{"url"},
},
}
}

type ImageRegistries []ImageRegistry

func (ImageRegistries) VariableSchema() clusterv1.VariableSchema {
return clusterv1.VariableSchema{
OpenAPIV3Schema: clusterv1.JSONSchemaProps{
Description: "Configuration for image registries.",
Type: "array",
Items: ptr.To(ImageRegistry{}.VariableSchema().OpenAPIV3Schema),
MaxItems: ptr.To[int64](1),
},
}
}

func init() {
SchemeBuilder.Register(&ClusterConfig{})
}
101 changes: 65 additions & 36 deletions api/v1alpha1/zz_generated.deepcopy.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading