Skip to content

Commit c2de147

Browse files
committed
docs: fix comments and mirror documentation
1 parent 87969b7 commit c2de147

File tree

2 files changed

+5
-4
lines changed

2 files changed

+5
-4
lines changed

api/v1alpha1/clusterconfig_types.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -242,8 +242,8 @@ func (ExtraAPIServerCertSANs) VariableSchema() clusterv1.VariableSchema {
242242
}
243243

244244
type ImageCredentials struct {
245-
// The Secret containing the registry credentials and CA certificate
246-
// The Secret should have keys 'username', 'password' and 'ca.crt'
245+
// The Secret containing the registry credentials and optional CA certificate
246+
// using the keys `username`, `password` and `ca.crt`.
247247
// This credentials Secret is not required for some registries, e.g. ECR.
248248
// +optional
249249
SecretRef *corev1.ObjectReference `json:"secretRef,omitempty"`
@@ -256,7 +256,7 @@ func (ImageCredentials) VariableSchema() clusterv1.VariableSchema {
256256
Properties: map[string]clusterv1.JSONSchemaProps{
257257
"secretRef": {
258258
Description: "The Secret containing the registry credentials. " +
259-
"The Secret should have keys 'username', 'password' and 'ca.crt' " +
259+
"The Secret should have keys 'username', 'password' and optional 'ca.crt' " +
260260
"This credentials Secret is not required for some registries, e.g. ECR.",
261261
Type: "object",
262262
Properties: map[string]clusterv1.JSONSchemaProps{

docs/content/customization/generic/global-mirror.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@ This customization will be available when the
1313

1414
To provide image registry mirror with CA certificate, specify the following configuration:
1515

16-
If your registry mirror requires self signed CA certifate, create a Kubernetes Secret with keys for `ca.crt`:
16+
If your registry mirror requires a private or self-signed CA certificate,
17+
create a Kubernetes Secret with the `ca.crt` key populated with the CA certificate in PEM format:
1718

1819
```shell
1920
kubectl create secret generic my-mirror-ca-cert-secret \

0 commit comments

Comments
 (0)