Skip to content

Commit 00fdf5e

Browse files
committed
docs: disable MD013 markdownlint to check line length
1 parent 78dc299 commit 00fdf5e

File tree

3 files changed

+3
-63
lines changed

3 files changed

+3
-63
lines changed

.markdownlint.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,6 @@
22
"heading-style": { "style": "atx" },
33
"ul-style": { "style": "dash" },
44
"line-length": { "line_length": 120, "stern": true },
5-
"hr-style": { "style": "---" }
5+
"hr-style": { "style": "---" },
6+
"MD013": false
67
}

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,7 @@ title = "Global Image Registry Mirror"
44

55
Add containerd image registry mirror configuration to all Nodes in the cluster.
66

7-
When the `globalImageRegistryMirror` variable is set, `files` with configurations for
8-
[Containerd default mirror](https://github.com/containerd/containerd/blob/main/docs/hosts.md#setup-default-mirror-for-all-registries) will be added.
7+
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.
98

109
This customization will be available when the
1110
[provider-specific cluster configuration patch]({{< ref "..">}}) is included in the `ClusterClass`.

docs/content/customization/generic/image-registries.md

Lines changed: 0 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -41,63 +41,3 @@ spec:
4141
4242
Applying this configuration will result in new files and preKubeadmCommands
4343
on the `KubeadmControlPlaneTemplate` and `KubeadmConfigTemplate`.
44-
45-
To use a image registry as mirror with CA certificate, specify the following configuration:
46-
47-
If your registry mirror requires self signed CA certifate, create a Kubernetes Secret with keys for `ca.crt`:
48-
49-
```shell
50-
kubectl create secret generic my-mirror-ca-cert-secret \
51-
--from-file=ca.crt=registry-ca.crt
52-
```
53-
54-
```yaml
55-
apiVersion: cluster.x-k8s.io/v1beta1
56-
kind: Cluster
57-
metadata:
58-
name: <NAME>
59-
spec:
60-
topology:
61-
variables:
62-
- name: clusterConfig
63-
value:
64-
imageRegistries:
65-
- url: https://my-registry.io
66-
credentials:
67-
secretRef:
68-
name: my-registry-credentials
69-
mirror:
70-
secretRef:
71-
name: my-mirror-ca-cert-secret
72-
```
73-
74-
Applying this configuration will result in following new files on the
75-
`KubeadmControlPlaneTemplate` and `KubeadmConfigTemplate`
76-
77-
- `/etc/containerd/certs.d/_default/hosts.toml`
78-
- `/etc/certs/mirror.pem`
79-
80-
To use a public hosted image registry (ex. ECR) as mirror, specify the following configuration:
81-
82-
```yaml
83-
apiVersion: cluster.x-k8s.io/v1beta1
84-
kind: Cluster
85-
metadata:
86-
name: <NAME>
87-
spec:
88-
topology:
89-
variables:
90-
- name: clusterConfig
91-
value:
92-
imageRegistries:
93-
- url: https://123456789.dkr.ecr.us-east-1.amazonaws.com
94-
credentials:
95-
secretRef:
96-
name: my-registry-credentials
97-
mirror: {}
98-
```
99-
100-
Applying this configuration will result in following new files on the
101-
`KubeadmControlPlaneTemplate` and `KubeadmConfigTemplate`
102-
103-
- `/etc/containerd/certs.d/_default/hosts.toml`

0 commit comments

Comments
 (0)