From 00fdf5ec102e7ad1ae764492fdeb20c7f24da96e Mon Sep 17 00:00:00 2001 From: Shalin Patel Date: Mon, 22 Jan 2024 20:00:34 -0800 Subject: [PATCH] docs: disable MD013 markdownlint to check line length --- .markdownlint.json | 3 +- .../customization/generic/global-mirror.md | 3 +- .../customization/generic/image-registries.md | 60 ------------------- 3 files changed, 3 insertions(+), 63 deletions(-) diff --git a/.markdownlint.json b/.markdownlint.json index 4af4c680f..2c20f6728 100644 --- a/.markdownlint.json +++ b/.markdownlint.json @@ -2,5 +2,6 @@ "heading-style": { "style": "atx" }, "ul-style": { "style": "dash" }, "line-length": { "line_length": 120, "stern": true }, - "hr-style": { "style": "---" } + "hr-style": { "style": "---" }, + "MD013": false } diff --git a/docs/content/customization/generic/global-mirror.md b/docs/content/customization/generic/global-mirror.md index b54f2f3bb..543de1129 100644 --- a/docs/content/customization/generic/global-mirror.md +++ b/docs/content/customization/generic/global-mirror.md @@ -4,8 +4,7 @@ title = "Global Image Registry Mirror" Add containerd image registry mirror configuration to all Nodes in the cluster. -When the `globalImageRegistryMirror` variable is set, `files` with configurations for -[Containerd default mirror](https://github.com/containerd/containerd/blob/main/docs/hosts.md#setup-default-mirror-for-all-registries) will be added. +When the `globalImageRegistryMirror` variable is set, `files` with configurations for [Containerd default mirror](https://github.com/containerd/containerd/blob/main/docs/hosts.md#setup-default-mirror-for-all-registries) will be added. This customization will be available when the [provider-specific cluster configuration patch]({{< ref "..">}}) is included in the `ClusterClass`. diff --git a/docs/content/customization/generic/image-registries.md b/docs/content/customization/generic/image-registries.md index 1013fb574..2c1e8b336 100644 --- a/docs/content/customization/generic/image-registries.md +++ b/docs/content/customization/generic/image-registries.md @@ -41,63 +41,3 @@ spec: Applying this configuration will result in new files and preKubeadmCommands on the `KubeadmControlPlaneTemplate` and `KubeadmConfigTemplate`. - -To use a image registry as mirror with CA certificate, specify the following configuration: - -If your registry mirror requires self signed CA certifate, create a Kubernetes Secret with keys for `ca.crt`: - -```shell -kubectl create secret generic my-mirror-ca-cert-secret \ - --from-file=ca.crt=registry-ca.crt -``` - -```yaml -apiVersion: cluster.x-k8s.io/v1beta1 -kind: Cluster -metadata: - name: -spec: - topology: - variables: - - name: clusterConfig - value: - imageRegistries: - - url: https://my-registry.io - credentials: - secretRef: - name: my-registry-credentials - mirror: - secretRef: - name: my-mirror-ca-cert-secret -``` - -Applying this configuration will result in following new files on the -`KubeadmControlPlaneTemplate` and `KubeadmConfigTemplate` - -- `/etc/containerd/certs.d/_default/hosts.toml` -- `/etc/certs/mirror.pem` - -To use a public hosted image registry (ex. ECR) as mirror, specify the following configuration: - -```yaml -apiVersion: cluster.x-k8s.io/v1beta1 -kind: Cluster -metadata: - name: -spec: - topology: - variables: - - name: clusterConfig - value: - imageRegistries: - - url: https://123456789.dkr.ecr.us-east-1.amazonaws.com - credentials: - secretRef: - name: my-registry-credentials - mirror: {} -``` - -Applying this configuration will result in following new files on the -`KubeadmControlPlaneTemplate` and `KubeadmConfigTemplate` - -- `/etc/containerd/certs.d/_default/hosts.toml`