Skip to content

Commit

Permalink
docs: disable MD013 markdownlint to check line length
Browse files Browse the repository at this point in the history
  • Loading branch information
supershal committed Jan 23, 2024
1 parent 78dc299 commit 00fdf5e
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 63 deletions.
3 changes: 2 additions & 1 deletion .markdownlint.json
Original file line number Diff line number Diff line change
Expand Up @@ -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
}
3 changes: 1 addition & 2 deletions docs/content/customization/generic/global-mirror.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down
60 changes: 0 additions & 60 deletions docs/content/customization/generic/image-registries.md
Original file line number Diff line number Diff line change
Expand Up @@ -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: <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: <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`

0 comments on commit 00fdf5e

Please sign in to comment.