Skip to content
This repository was archived by the owner on Feb 12, 2021. It is now read-only.

Commit fc211d5

Browse files
committed
*: update info string in config fences
This will allow the blocks to render correctly on both GitHub and coreos.com.
1 parent b79621a commit fc211d5

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+92
-92
lines changed

coreupdate/configure-machines.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ For example, here is what the Alpha group looks like in CoreUpdate:
2424

2525
Here's the Container Linux Config to use:
2626

27-
```container-linux-config
27+
```yaml container-linux-config
2828
update:
2929
group: alpha
3030
server: https://customer.update.core-os.net/v1/update/
@@ -40,7 +40,7 @@ For example, here is what "NYC Production" looks like in CoreUpdate:
4040

4141
Here's the Container Linux Config to use:
4242

43-
```container-linux-config
43+
```yaml container-linux-config
4444
update:
4545
group: 0a809ab1-c01c-4a6b-8ac8-6b17cb9bae09
4646
server: https://customer.update.core-os.net/v1/update/

etcd/etcd-live-cluster-reconfiguration.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This document describes the reconfiguration or recovery of an etcd cluster runni
66

77
When [a Container Linux Config][cl-configs] is used to configure an etcd member on a Container Linux node, it compiles a special `/etc/systemd/system/etcd-member.service.d/20-clct-etcd-member.conf` [drop-in unit file][drop-in]. That is, the Container Linux Config below:
88

9-
```container-linux-config
9+
```yaml container-linux-config
1010
etcd:
1111
advertise_client_urls: http://<PEER_ADDRESS>:2379
1212
initial_advertise_peer_urls: http://<PEER_ADDRESS>:2380
@@ -76,7 +76,7 @@ This section provides instructions on how to recover a failed etcd member. It is
7676

7777
In this example, we use a 3-member etcd cluster with one failed node, that is still running and has maintained [quorum][majority]. An etcd member node might fail for several reasons: out of disk space, an incorrect reboot, or issues on the underlying system. Note that this example assumes you used [a Container Linux Config][cl-configs] with an etcd [discovery URL][etcd-discovery] to bootstrap your cluster, with the following default options:
7878

79-
```container-linux-config
79+
```yaml container-linux-config
8080
etcd:
8181
advertise_client_urls: http://<PEER_ADDRESS>:2379
8282
initial_advertise_peer_urls: http://<PEER_ADDRESS>:2380

etcd/getting-started-with-etcd.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ To upgrade an existing etcd v2 cluster rather than deploy a new one, start with
1818

1919
A Container Linux Config can be used to set any etcd option, like in this example:
2020

21-
```container-linux-config
21+
```yaml container-linux-config
2222
etcd:
2323
name: my-etcd-1
2424
listen_client_urls: https://10.240.0.1:2379

etcd/tls-etcd-clients.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ This document assumes three Container Linux nodes will be booted and will be run
1414

1515
Flannel options can be specified in a Container Linux Config. For an example, this is a config that sets the etcd endpoints flannel will use and specifies tls resources to encrypt the connection:
1616

17-
```container-linux-config
17+
```yaml container-linux-config
1818
flannel:
1919
etcd_endpoints: "https://172.16.0.101:2379,https://172.16.0.102:2379,https://172.16.0.103:2379"
2020
etcd_cafile: /etc/ssl/etcd/ca.pem
@@ -28,7 +28,7 @@ Suppose you're using `/etc/etcd/ssl` instead, you will need to adjust the flanne
2828

2929
A complete example would look like:
3030

31-
```container-linux-config
31+
```yaml container-linux-config
3232
flannel:
3333
etcd_endpoints: "https://172.16.0.101:2379,https://172.16.0.102:2379,https://172.16.0.103:2379"
3434
etcd_cafile: /etc/ssl/etcd/ca.pem
@@ -47,7 +47,7 @@ systemd:
4747

4848
Due to the [deprecation of fleet][fleet-deprecation], Container Linux Configs don't have a convenient syntax for configuring fleet like for flannel. Fleet can still be easily configured however with the use of a systemd drop-in.
4949

50-
```container-linux-config
50+
```yaml container-linux-config
5151
systemd:
5252
units:
5353
- name: fleet.service
@@ -67,7 +67,7 @@ systemd:
6767

6868
Example Container Linux Config excerpt for Locksmith configuration:
6969

70-
```container-linux-config
70+
```yaml container-linux-config
7171
systemd:
7272
units:
7373
- name: locksmithd.service

flannel/flannel-config.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ $ etcdctl set /coreos.com/network/config '{ "Network": "10.1.0.0/16" }'
2626

2727
You can put this into a drop-in for flanneld.service via a Container Linux Config:
2828

29-
```container-linux-config
29+
```yaml container-linux-config
3030
systemd:
3131
units:
3232
- name: flanneld.service
@@ -47,7 +47,7 @@ flannel uses UDP port 8285 for sending encapsulated IP packets. Make sure to ena
4747
4848
The last step is to enable `flanneld.service` by creating the `flannel` section in our Container Linux Config. Options for flannel can be specified in this section.
4949

50-
```container-linux-config
50+
```yaml container-linux-config
5151
flannel:
5252
```
5353

@@ -57,7 +57,7 @@ flannel:
5757

5858
Flannel requires SSL certificates to communicate with a secure etcd cluster. By default, flannel looks for these certificates in `/etc/ssl/etcd`. To use different certificates, add `Environment=ETCD_SSL_DIR` to a drop-in file for `flanneld.service`. Use the following configuration snippet to achieve this:
5959

60-
```container-linux-config
60+
```yaml container-linux-config
6161
systemd:
6262
units:
6363
- name: flanneld.service

fleet/launching-containers-fleet.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -297,7 +297,7 @@ MachineMetadata=region=east
297297
298298
On Container Linux, only fleet 0.11.x is available under /usr/bin. That one might be obsolete for users who want to try out more recent versions. In that case, users should define their own custom Container Linux Config to be able to run any version of fleet as they want. For example:
299299
300-
```container-linux-config
300+
```yaml container-linux-config
301301
storage:
302302
files:
303303
- path: /opt/bin/fleet-wrapper

os/adding-swap.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ The block device mounted at `/var/`, `/dev/sdXN`, is the correct filesystem type
8181

8282
The following config sets up a 1GiB swapfile located at `/var/vm/swapfile1`.
8383

84-
```container-linux-config
84+
```yaml container-linux-config
8585
systemd:
8686
units:
8787
- name: swap.service

os/adding-users.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ You can create user accounts on a CoreOS Container Linux machine manually with `
66

77
In your Container Linux Config, you can specify many [different parameters](https://github.com/coreos/container-linux-config-transpiler/blob/master/doc/configuration.md) for each user. Here's an example:
88

9-
```container-linux-config
9+
```yaml container-linux-config
1010
passwd:
1111
users:
1212
- name: core

os/booting-on-azure.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ You can provide a raw Ignition config (produced from a Container Linux Config) t
4242

4343
As an example, this config will configure and start etcd:
4444

45-
```container-linux-config:azure
45+
```yaml container-linux-config:azure
4646
etcd:
4747
# All options get passed as command line flags to etcd.
4848
# Any information inside curly braces comes from the machine at boot time.

os/booting-on-digitalocean.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ You can provide a raw Ignition config to Container Linux via the DigitalOcean we
7878

7979
As an example, this config will configure and start etcd:
8080

81-
```container-linux-config:digitalocean
81+
```yaml container-linux-config:digitalocean
8282
etcd:
8383
# All options get passed as command line flags to etcd.
8484
# Any information inside curly braces comes from the machine at boot time.

os/booting-on-ec2.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ You can provide a raw Ignition config to Container Linux via the Amazon web cons
122122

123123
As an example, this Container Linux Config will configure and start etcd:
124124

125-
```container-linux-config:ec2
125+
```yaml container-linux-config:ec2
126126
etcd:
127127
# All options get passed as command line flags to etcd.
128128
# Any information inside curly braces comes from the machine at boot time.
@@ -146,7 +146,7 @@ etcd:
146146
147147
Ephemeral disks and additional EBS volumes attached to instances can be mounted with a `.mount` unit. Amazon's block storage devices are attached differently [depending on the instance type](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html#InstanceStoreDeviceNames). Here's the Container Linux Config to format and mount the first ephemeral disk, `xvdb`, on most instance types:
148148

149-
```container-linux-config:ec2
149+
```yaml container-linux-config:ec2
150150
storage:
151151
filesystems:
152152
- mount:
@@ -258,7 +258,7 @@ First we need to create a security group to allow Container Linux instances to c
258258
</li>
259259
<li>
260260
Use <a href="provisioning.md">ct</a> to convert the following configuration into an Ignition config, and back in the EC2 dashboard, paste it into the "User Data" field.
261-
```container-linux-config:ec2
261+
```yaml container-linux-config:ec2
262262
etcd:
263263
# All options get passed as command line flags to etcd.
264264
# Any information inside curly braces comes from the machine at boot time.
@@ -332,7 +332,7 @@ First we need to create a security group to allow Container Linux instances to c
332332
</li>
333333
<li>
334334
Use <a href="provisioning.md">ct</a> to convert the following configuration into an Ignition config, and back in the EC2 dashboard, paste it into the "User Data" field.
335-
```container-linux-config:ec2
335+
```yaml container-linux-config:ec2
336336
etcd:
337337
# All options get passed as command line flags to etcd.
338338
# Any information inside curly braces comes from the machine at boot time.
@@ -406,7 +406,7 @@ First we need to create a security group to allow Container Linux instances to c
406406
</li>
407407
<li>
408408
Use <a href="provisioning.md">ct</a> to convert the following configuration into an Ignition config, and back in the EC2 dashboard, paste it into the "User Data" field.
409-
```container-linux-config:ec2
409+
```yaml container-linux-config:ec2
410410
etcd:
411411
# All options get passed as command line flags to etcd.
412412
# Any information inside curly braces comes from the machine at boot time.

os/booting-on-ecs.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ When booting your [Container Linux Machines on EC2](booting-on-ec2.md), configur
1010

1111
Be sure to change `ECS_CLUSTER` to the cluster name you've configured via the ECS CLI or leave it empty for the default. Here's a full config example:
1212

13-
```container-linux-config:ec2
13+
```yaml container-linux-config:ec2
1414
systemd:
1515
units:
1616
- name: amazon-ecs-agent.service

os/booting-on-google-compute-engine.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ You can provide a raw Ignition config to Container Linux via the Google Cloud co
1616

1717
As an example, this config will configure and start etcd:
1818

19-
```container-linux-config:gce
19+
```yaml container-linux-config:gce
2020
etcd:
2121
# All options get passed as command line flags to etcd.
2222
# Any information inside curly braces comes from the machine at boot time.
@@ -67,7 +67,7 @@ Create 3 instances from the image above using our Ignition from `example.ign`:
6767

6868
Additional disks attached to instances can be mounted with a `.mount` unit. Each disk can be accessed via `/dev/disk/by-id/google-<disk-name>`. Here's the Container Linux Config to format and mount a disk called `database-backup`:
6969

70-
```container-linux-config:gce
70+
```yaml container-linux-config:gce
7171
storage:
7272
filesystems:
7373
- mount:

os/booting-on-openstack.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ Container Linux allows you to configure machine parameters, launch systemd units
8080

8181
A common Container Linux Config for OpenStack looks like:
8282

83-
```container-linux-config:openstack-metadata
83+
```yaml container-linux-config:openstack-metadata
8484
etcd:
8585
# All options get passed as command line flags to etcd.
8686
# Any information inside curly braces comes from the machine at boot time.

os/booting-on-packet.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ You can provide a raw Ignition config to Container Linux via Packet's userdata f
3939

4040
As an example, this config will configure and start etcd:
4141

42-
```container-linux-config:packet
42+
```yaml container-linux-config:packet
4343
etcd:
4444
# All options get passed as command line flags to etcd.
4545
# Any information inside curly braces comes from the machine at boot time.

os/booting-on-vmware.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ You can provide a raw Ignition config to Container Linux via VMware's [Guestinfo
7676

7777
As an example, this config will start etcd:
7878

79-
```container-linux-config
79+
```yaml container-linux-config
8080
etcd:
8181
# All options get passed as command line flags to etcd.
8282
# Any information inside curly braces comes from the machine at boot time.

os/booting-with-pxe.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ label coreos
4444

4545
Here's a common config example which should be located at the URL from above:
4646

47-
```container-linux-config
47+
```yaml container-linux-config
4848
systemd:
4949
units:
5050
- name: etcd2.service
@@ -147,7 +147,7 @@ If you plan on using Docker we recommend using a local ext4 filesystem with over
147147

148148
For example, to setup an ext4 root filesystem on `/dev/sda`:
149149

150-
```container-linux-config
150+
```yaml container-linux-config
151151
storage:
152152
disks:
153153
- device: /dev/sda
@@ -167,7 +167,7 @@ And add `root=/dev/sda1` or `root=LABEL=ROOT` to the kernel options as documente
167167

168168
Similarly, to setup a btrfs root filesystem on `/dev/sda`:
169169

170-
```container-linux-config
170+
```yaml container-linux-config
171171
storage:
172172
disks:
173173
- device: /dev/sda

os/cluster-discovery.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The discovery URL can be provided to each Container Linux machine via [Container
1515

1616
Boot each one of the machines with identical Container Linux Config and they should be automatically clustered:
1717

18-
```container-linux-config:ec2
18+
```yaml container-linux-config:ec2
1919
etcd:
2020
# generate a new token for each unique cluster from https://discovery.etcd.io/new?size=3
2121
# specify the initial size of your cluster with ?size=X

os/configuring-date-and-timezone.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ $ sudo systemctl restart systemd-networkd
121121

122122
NTP time sources can be set in `timesyncd.conf` with a [Container Linux Config][cl-configs] snippet like:
123123

124-
```container-linux-config
124+
```yaml container-linux-config
125125
storage:
126126
files:
127127
- path: /etc/systemd/timesyncd.conf
@@ -147,7 +147,7 @@ $ sudo systemctl start ntpd
147147
148148
or with this Container Linux Config snippet:
149149
150-
```container-linux-config
150+
```yaml container-linux-config
151151
systemd:
152152
units:
153153
- name: systemd-timesyncd.service
@@ -179,7 +179,7 @@ $ sudo systemctl reload ntpd
179179

180180
Or, in a [Container Linux Config][cl-configs]:
181181

182-
```container-linux-config
182+
```yaml container-linux-config
183183
storage:
184184
files:
185185
- path: /etc/ntp.conf

os/configuring-dns.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ By default, DNS resolution on Container Linux is handled through `/etc/resolv.co
88

99
Here is an example [Container Linux Config][cl-configs] snippet to do that:
1010

11-
```container-linux-config
11+
```yaml container-linux-config
1212
storage:
1313
files:
1414
- path: /etc/nsswitch.conf

os/customize-etcd-unit.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ etcd supports client certificates as a way to provide secure communication betwe
88

99
Please follow the [instruction](generate-self-signed-certificates.md) to know how to create self-signed certificates and private keys.
1010

11-
```container-linux-config
11+
```yaml container-linux-config
1212
etcd:
1313
# More settings are needed here for a functioning etcd daemon
1414
ca_file: /path/to/CA.pem

os/customizing-docker.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ docker -H tcp://127.0.0.1:2375 ps
3838

3939
To enable the remote API on every Container Linux machine in a cluster, use a [Container Linux Config][cl-configs]. We need to provide the new socket file and Docker's socket activation support will automatically start using the socket:
4040

41-
```container-linux-config
41+
```yaml container-linux-config
4242
systemd:
4343
units:
4444
- name: docker-tcp.socket
@@ -162,7 +162,7 @@ docker images
162162

163163
A Container Linux Config for Docker TLS authentication will look like:
164164

165-
```container-linux-config
165+
```yaml container-linux-config
166166
storage:
167167
files:
168168
- path: /etc/docker/ca.pem
@@ -249,7 +249,7 @@ journalctl -u docker
249249

250250
If you need to modify a flag across many machines, you can add the flag with a Container Linux Config:
251251

252-
```container-linux-config
252+
```yaml container-linux-config
253253
docker:
254254
flags:
255255
- --debug
@@ -283,7 +283,7 @@ Proxy environment variables can also be set [system-wide][systemd-env-vars].
283283

284284
The easiest way to use this proxy on all of your machines is via a Container Linux Config:
285285

286-
```container-linux-config
286+
```yaml container-linux-config
287287
systemd:
288288
units:
289289
- name: docker.service
@@ -321,7 +321,7 @@ systemctl restart docker
321321

322322
The easiest way to use these new ulimits on all of your machines is via a Container Linux Config:
323323

324-
```container-linux-configs
324+
```yaml container-linux-configs
325325
systemd:
326326
units:
327327
- name: docker.service

0 commit comments

Comments
 (0)