You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/add-ons/helm.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,9 +4,9 @@ title: Helm
4
4
5
5
Helm is the package management tool of choice for Kubernetes. Helm charts provide templating syntax for Kubernetes YAML manifest documents. With Helm, developers or cluster administrators can create configurable templates known as Charts, instead of just using static manifests. For more information about creating your own Chart catalog, check out the docs at [https://helm.sh/docs/intro/quickstart/](https://helm.sh/docs/intro/quickstart/).
6
6
7
-
K3s does not require any special configuration to support Helm. Just be sure you have properly set the kubeconfig path as per the [cluster access](./cluster-access.md) documentation.
7
+
K3s does not require any special configuration to support Helm. Just be sure you have properly set the kubeconfig path as per the [cluster access](../cluster-access.md) documentation.
8
8
9
-
K3s includes a [Helm Controller](https://github.com/k3s-io/helm-controller/) that manages installing, upgrading/reconfiguring, and uninstalling Helm charts using a HelmChart Custom Resource Definition (CRD). Paired with [auto-deploying AddOn manifests](./installation/packaged-components.md), installing a Helm chart on your cluster can be automated by creating a single file on disk.
9
+
K3s includes a [Helm Controller](https://github.com/k3s-io/helm-controller/) that manages installing, upgrading/reconfiguring, and uninstalling Helm charts using a HelmChart Custom Resource Definition (CRD). Paired with [auto-deploying AddOn manifests](../installation/packaged-components.md), installing a Helm chart on your cluster can be automated by creating a single file on disk.
Copy file name to clipboardExpand all lines: docs/add-ons/import-images.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ Container images are cached locally on each node by the containerd image store.
6
6
7
7
## On-demand image pulling
8
8
9
-
Kubernetes, by default, automatically pulls images when a Pod requires them if the image is not already present on the node. This behavior can be changed by using the [image pull policy](https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy) field of the Pod. When using the default `IfNotPresent` policy, containerd will pull the image from either upstream (default) or your [private registry](installation/private-registry.md) and store it in its image store. Users do not need to apply any additional configuration for on-demand image pulling to work.
9
+
Kubernetes, by default, automatically pulls images when a Pod requires them if the image is not already present on the node. This behavior can be changed by using the [image pull policy](https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy) field of the Pod. When using the default `IfNotPresent` policy, containerd will pull the image from either upstream (default) or your [private registry](../installation/private-registry.md) and store it in its image store. Users do not need to apply any additional configuration for on-demand image pulling to work.
10
10
11
11
12
12
## Pre-import images
@@ -21,7 +21,7 @@ K3s includes two mechanisms to pre-import images into the containerd image store
21
21
<TabsgroupId="import-images"queryString>
22
22
<TabItemvalue="Online image importing"default>
23
23
24
-
Users can trigger a pull of images into the containerd image store by placing a text file containing the image names, one per line, in the `/var/lib/rancher/k3s/agent/images` directory. The text file can be placed before K3s is started, or created/modified while K3s is running. K3s will sequentially pull the images via the CRI API, optionally using the [registries.yaml](installation/private-registry.md) configuration.
24
+
Users can trigger a pull of images into the containerd image store by placing a text file containing the image names, one per line, in the `/var/lib/rancher/k3s/agent/images` directory. The text file can be placed before K3s is started, or created/modified while K3s is running. K3s will sequentially pull the images via the CRI API, optionally using the [registries.yaml](../installation/private-registry.md) configuration.
25
25
26
26
For example:
27
27
@@ -57,7 +57,7 @@ After a few seconds, the images included in the image tarball will be available
57
57
58
58
Use `sudo k3s ctr images list` to query the containerd image store.
59
59
60
-
This is the method used in Airgap. Please follow the [Airgap install documentation](installation/airgap.md) for detailed information.
60
+
This is the method used in Airgap. Please follow the [Airgap install documentation](../installation/airgap.md) for detailed information.
61
61
62
62
</TabItem>
63
63
</Tabs>
@@ -66,6 +66,6 @@ This is the method used in Airgap. Please follow the [Airgap install documentati
66
66
67
67
K3s supports two alternatives for image registries:
68
68
69
-
*[Private Registry Configuration](installation/private-registry.md) covers use of `registries.yaml` to configure container image registry authentication and mirroring.
69
+
*[Private Registry Configuration](../installation/private-registry.md) covers use of `registries.yaml` to configure container image registry authentication and mirroring.
70
70
71
-
*[Embedded Registry Mirror](installation/registry-mirror.md) shows how to enable the embedded distributed image registry mirror, for peer-to-peer sharing of images between nodes.
71
+
*[Embedded Registry Mirror](../installation/registry-mirror.md) shows how to enable the embedded distributed image registry mirror, for peer-to-peer sharing of images between nodes.
Copy file name to clipboardExpand all lines: docs/installation/registry-mirror.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@ This option enables the embedded mirror for use on all nodes in the cluster.
16
16
When enabled at a cluster level, all nodes will host a local OCI registry on port 6443,
17
17
and publish a list of available images via a peer to peer network on port 5001.
18
18
Any image available in the containerd image store on any node, can be pulled by other cluster members without access to an external registry.
19
-
Images imported via [air-gap image tar files](./airgap.md?airgap-load-images=Manually+Deploy+Images) or [pre-imported](../import-images.md#pre-import-images) are pinned in containerd to ensure that they remain available and are not pruned by Kubelet garbage collection.
19
+
Images imported via [air-gap image tar files](./airgap.md?airgap-load-images=Manually+Deploy+Images) or [pre-imported](../add-ons/import-images.md#pre-import-images) are pinned in containerd to ensure that they remain available and are not pruned by Kubelet garbage collection.
20
20
21
21
The peer to peer port can changed from 5001 by setting the `K3S_P2P_PORT` environment variable for the K3s service. The port must be set to the same value on all nodes.
22
22
Changing the port is unsupported and not recommended.
@@ -129,7 +129,7 @@ If image integrity is important, you should use image digests instead of tags, a
129
129
## Sharing Air-gap or Manually Loaded Images
130
130
131
131
Image sharing is controlled based on the source registry.
132
-
Images loaded directly into containerd via [air-gap tarballs](./airgap.md?airgap-load-images=Manually+Deploy+Images), [pre-imported](../import-images.md#pre-import-images) or loaded directly into containerd's image store using the `ctr` command line tool, will be shared between nodes if they are tagged as being from a registry that is enabled for mirroring.
132
+
Images loaded directly into containerd via [air-gap tarballs](./airgap.md?airgap-load-images=Manually+Deploy+Images), [pre-imported](../add-ons/import-images.md#pre-import-images) or loaded directly into containerd's image store using the `ctr` command line tool, will be shared between nodes if they are tagged as being from a registry that is enabled for mirroring.
133
133
134
134
Note that the upstream registry that the images appear to come from does not actually have to exist or be reachable.
135
135
For example, you could tag images as being from a fictitious upstream registry, and import those images into containerd's image store.
@@ -140,5 +140,5 @@ You would then be able to pull those images from all cluster members, as long as
140
140
The embedded registry is read-only, and cannot be pushed to directly using `docker push` or other common tools that interact with OCI registries.
141
141
142
142
Images can be manually made available via the embedded registry by running `ctr -n k8s.io image pull` to pull an image,
143
-
or by loading image archives created by `docker save` via the `ctr -n k8s.io image import` command or the [pre-import feature](../import-images.md#pre-import-images).
143
+
or by loading image archives created by `docker save` via the `ctr -n k8s.io image import` command or the [pre-import feature](../add-ons/import-images.md#pre-import-images).
144
144
Note that the `k8s.io` namespace must be specified when managing images via `ctr` in order for them to be visible to the kubelet.
Copy file name to clipboardExpand all lines: docs/installation/uninstall.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ Uninstalling K3s may cause data loss!
8
8
9
9
If you installed K3s using the installation script, a script to uninstall K3s was generated during installation.
10
10
11
-
Running the uninstall script stops K3s and all running pods, and deletes the local cluster datastore, [Local Storage](../storage.md#setting-up-the-local-storage-provider) Persistent Volume data, node configuration, and all of the scripts and CLI tools.
11
+
Running the uninstall script stops K3s and all running pods, and deletes the local cluster datastore, [Local Storage](../add-ons/storage.md#setting-up-the-local-storage-provider) Persistent Volume data, node configuration, and all of the scripts and CLI tools.
12
12
It does not remove any data from external datastores, or created by pods using external Kubernetes Persistent Volumes.
13
13
14
14
If you are planning on rejoining a node to an existing cluster after uninstalling and reinstalling, be sure to delete the node from the cluster to ensure that the node password secret is removed. See the [Node Registration](../architecture.md#how-agent-node-registration-works) documentation for more information.
Copy file name to clipboardExpand all lines: docs/networking/networking-services.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,7 +26,7 @@ To restrict the nodes used by Traefik, and by extension the node IPs advertised
26
26
27
27
Traefik is deployed by default when starting the server. The default chart values can be found in `/var/lib/rancher/k3s/server/manifests/traefik.yaml`, but this file should not be edited manually, as K3s will replace the file with defaults at startup.
28
28
Instead, you should customize Traefik by creating an additional `HelmChartConfig` manifest in `/var/lib/rancher/k3s/server/manifests`.
29
-
For more details and an example see [Customizing Packaged Components with HelmChartConfig](../helm.md#customizing-packaged-components-with-helmchartconfig).
29
+
For more details and an example see [Customizing Packaged Components with HelmChartConfig](../add-ons/helm.md#customizing-packaged-components-with-helmchartconfig).
30
30
For more information on the possible configuration values, refer to `values.yaml` of the [Traefik Helm Chart](https://github.com/k3s-io/k3s-charts/tree/main/charts/traefik) included with your version of K3s.
31
31
32
32
To remove Traefik from your cluster, start all servers with the `--disable=traefik` flag.
0 commit comments