Skip to content

Commit a6b6548

Browse files
authored
docs: remove torcx and deprecate clc (#521)
2 parents e21a5df + c6b838c commit a6b6548

File tree

9 files changed

+7
-205
lines changed

9 files changed

+7
-205
lines changed

content/docs/latest/container-runtimes/customizing-docker.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,7 @@ For switching to using containerd with Kubernetes, there is an [extra guide](../
1414

1515
## Use a custom containerd configuration
1616

17-
The default configuration under `/run/torcx/unpack/docker/usr/share/containerd/config.toml` can't be changed but you can copy it to `/etc/containerd/config.toml` and modify it.
18-
**NOTE** that newer Flatcar major releases (above major release version 3760) ship the default configuration under `/usr/share/containerd/config.toml`.
17+
The default configuration under `/usr/share/containerd/config.toml` can't be changed but you can copy it to `/etc/containerd/config.toml` and modify it.
1918

2019
Create a `/etc/systemd/system/containerd.service.d/10-use-custom-config.conf` unit drop-in file to select the new configuration:
2120

content/docs/latest/container-runtimes/getting-started-with-kubernetes.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -358,10 +358,6 @@ to the following directories on the host file system:
358358
- `/var/lib/containerd/`
359359

360360
And that it has access to the following binaries on the host file system and that they are included in `PATH`:
361-
- For Flatcar releases until major version 3760:
362-
- `/run/torcx/unpack/docker/bin/containerd-shim-runc-v1`
363-
- `/run/torcx/unpack/docker/bin/containerd-shim-runc-v2`
364-
- For Flatcar releases above major version 3760:
365361
- `/usr/bin/containerd-shim-runc-v1`
366362
- `/usr/bin/containerd-shim-runc-v2`
367363

content/docs/latest/installing/cloud/vmware.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ For DHCP you don't need to specify any networkd units.
157157
After transpilation, the resulting JSON content can be used in `guestinfo.ignition.config.data` after encoding it to base64 and setting `guestinfo.ignition.config.data.encoding` to `base64`.
158158
If DHCP is used, the JSON file can also be uploaded to a web server and fetched by Ignition if the HTTP(s) URL is given in `guestinfo.ignition.config.url`.
159159

160-
Beginning with Flatcar major version 3248, fetching remote resources in Ignition or with torcx is not only supported with DHCP but also by using `guestinfo.afterburn.initrd.network-kargs` to define a custom network configuration, here an [example for a static IP address](https://coreos.github.io/afterburn/usage/initrd-network-cmdline/#vmware).
160+
Beginning with Flatcar major version 3248, fetching remote resources in Ignition is not only supported with DHCP but also by using `guestinfo.afterburn.initrd.network-kargs` to define a custom network configuration, here an [example for a static IP address](https://coreos.github.io/afterburn/usage/initrd-network-cmdline/#vmware).
161161

162162
IP configuration specified via `guestinfo.interface.*` and `guestinfo.dns.*` variables is currently not supported with Ignition and will only work if you provide coreos-cloudinit data (cloud-config or a script) as userdata.
163163

content/docs/latest/provisioning/cl-config/_index.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
11
---
2-
title: Container Linux Config Transpiler
3-
linktitle: Container Linux Config Transpiler
2+
title: "[DEPRECATED / EOL] Container Linux Config Transpiler"
43
description: YAML configuration format used to generate Ignition configs.
54
weight: 20
65
aliases:
76
- ../os/provisioning
87
- ../reference/migrating-to-clcs/provisioning
98
---
109

10+
:warning: TL; DR: Use [Butane](../config-transpiler). While Flatcar does support both Ignition spec version (2.x and 3.x), we encourage folks to use [Butane](../config-transpiler) first but we still maintain / document backward compatibility for users who still rely on Ignition 2.x. :warning:
11+
1112
Flatcar Container Linux automates machine provisioning with a specialized system for applying initial configuration. This system implements a process of (trans)compilation and validation for machine configs, and an atomic service to apply validated configurations to machines.
1213

1314
## Container Linux Config

content/docs/latest/provisioning/config-transpiler/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ The resulting Ignition config is very much not intended to be human-friendly. It
1919
[butane]: https://github.com/coreos/butane/
2020
[ignition]: https://github.com/coreos/ignition
2121

22-
**Note:**: Butane is utilized to generate Ignition v3+ configurations. If you are still utilizing a version of Container Linux that requires Ignition v2, you can refer to the [Container Linux Config Transpiler][cl-config] documentation. This particularly applies to those using the current LTS releases.
22+
**Note:** Butane is utilized to generate Ignition v3+ configurations. If you are still utilizing a version of Container Linux that requires Ignition v2, you can refer to the [Container Linux Config Transpiler][cl-config] documentation.
2323

2424
## Why a two-step process?
2525

content/docs/latest/provisioning/sysext/_index.md

Lines changed: 1 addition & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@ weight: 39
66

77
Flatcar Container Linux bundles various software components with fixed versions together into one release.
88
For users that require a particular version of a software component this means that the software needs to be supplied out of band and overwrite the built-in software copy.
9-
In the past Torcx was introduced as a way to switch between Docker versions.
109
Another approach we recommended was to [store binaries in `/opt/bin`](../../container-runtimes/use-a-custom-docker-or-containerd-version/) and prefer them in the `PATH`.
1110

1211
For long time already, the systemd project provided the portable services feature to address deploying custom services.
@@ -20,11 +19,6 @@ Here's some blog posts you can read for more context:
2019
2. https://www.flatcar.org/blog/2023/07/summer-2023-my-internship-experience/
2120
3. https://www.flatcar.org/blog/2023/12/extending-flatcar-say-goodbye-to-torcx-and-hello-to-systemd-sysext/
2221

23-
## Torcx deprecation
24-
25-
Since systemd-sysext is a more generic and maintained solution than Torcx, it replaced Torcx since Flatcar version 3794.0.0 and the last major version to include Torcx was 3760.
26-
Any Torcx usage should be migrated by converting your Torcx image with the `convert_torcx_image.sh` helper script from the [`sysext-bakery`][sysext-bakery] repository, mentioned later in this document. The inbuilt Docker and containerd versions can be disabled which is also showed further below.
27-
2822
## Types of systemd-sysext images
2923

3024
For Flatcar, two types of systemd-sysext images are provided:
@@ -120,7 +114,7 @@ Upholds=docker.socket
120114
## Supplying your sysext image from Ignition
121115

122116
The following Butane Config YAML can be be transpiled to Ignition JSON and will download a custom Docker+containerd sysext image on first boot.
123-
It also takes care of disabling Torcx and future built-in Docker and containerd sysext images we plan to ship in Flatcar (to revert this, you can find the original target of the symlinks in `/usr/share/flatcar/etc/extensions/` - as said, this is not yet shipped).
117+
It also takes care of disabling built-in Docker and containerd sysext images (to revert this, you can find the original target of the symlinks in `/usr/share/flatcar/etc/extensions/`).
124118

125119
```yaml
126120
variant: flatcar
@@ -131,7 +125,6 @@ storage:
131125
mode: 0644
132126
contents:
133127
source: https://myserver.net/mydocker.raw
134-
- path: /etc/systemd/system-generators/torcx-generator
135128
links:
136129
- path: /etc/extensions/docker-flatcar.raw
137130
target: /dev/null
@@ -169,17 +162,6 @@ To ease the process, the [`create_docker_sysext.sh`](https://raw.githubuserconte
169162
[… writes mydocker.raw into current directory …]
170163
```
171164

172-
## Converting a Torcx image
173-
174-
In case you have an existing Torcx image you can convert it with the [`convert_torcx_image.sh`](https://raw.githubusercontent.com/flatcar/sysext-bakery/main/convert_torcx_image.sh) helper script (Currently only Torcx tar balls are supported and the conversion is done on best effort):
175-
176-
```
177-
./convert_torcx_image.sh TORCXTAR SYSEXTNAME
178-
[… writes SYSEXTNAME.raw into the current directory …]
179-
```
180-
181-
Please make also sure that your don't have a `containerd.service` drop in file under `/etc` that uses Torcx paths.
182-
183165
## Updating custom sysext images
184166

185167
From Flatcar 3510.2.0, it is possible to use the `systemd-sysupdate` tool that covers the task of downloading newer versions of your sysext image at runtime from a location you specify.

content/docs/latest/provisioning/torcx/_index.md

Lines changed: 0 additions & 46 deletions
This file was deleted.

content/docs/latest/provisioning/torcx/metadata-and-systemd-target.md

Lines changed: 0 additions & 83 deletions
This file was deleted.

content/docs/latest/provisioning/torcx/troubleshooting.md

Lines changed: 0 additions & 47 deletions
This file was deleted.

0 commit comments

Comments
 (0)