Skip to content

Commit

Permalink
docs/main: add new exp specs to docs generation, and run it
Browse files Browse the repository at this point in the history
Add new exp specs to doc generation and then run it. Produces
new documentation for exp specs and updated old .md files for now
stabilized specs.
  • Loading branch information
prestist committed Nov 22, 2024
1 parent dc751e7 commit b626e3c
Show file tree
Hide file tree
Showing 11 changed files with 757 additions and 16 deletions.
229 changes: 229 additions & 0 deletions docs/config-fcos-v1_6.md

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions docs/config-fcos-v1_6-exp.md → docs/config-fcos-v1_7-exp.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
# This file is automatically generated from internal/doc and Ignition's
# config/doc. Do not edit.
title: Fedora CoreOS v1.6.0-experimental
title: Fedora CoreOS v1.7.0-experimental
parent: Configuration specifications
nav_order: 50
---

# Fedora CoreOS Specification v1.6.0-experimental
# Fedora CoreOS Specification v1.7.0-experimental

**Note: This configuration is experimental and has not been stabilized. It is subject to change without warning or announcement.**

Expand All @@ -15,7 +15,7 @@ The Fedora CoreOS configuration is a YAML document conforming to the following s
<div id="spec-docs"></div>

* **variant** (string): used to differentiate configs for different operating systems. Must be `fcos` for this specification.
* **version** (string): the semantic version of the spec for this document. This document is for version `1.6.0-experimental` and generates Ignition configs with version `3.5.0-experimental`.
* **version** (string): the semantic version of the spec for this document. This document is for version `1.7.0-experimental` and generates Ignition configs with version `3.6.0-experimental`.
* **_ignition_** (object): metadata about the configuration itself.
* **_config_** (object): options related to the configuration.
* **_merge_** (list of objects): a list of the configs to be merged to the current config.
Expand Down Expand Up @@ -169,7 +169,7 @@ The Fedora CoreOS configuration is a YAML document conforming to the following s
* **config** (string): the clevis configuration JSON.
* **_needs_network_** (boolean): whether or not the device requires networking.
* **_cex_** (object): describes the IBM Crypto Express (CEX) card configuration for the luks device.
* **_enabled_** (boolean): whether or not to use a CEX secure key to encrypt the luks device.
* **_enabled_** (boolean): whether or not to enable cex compatibility for luks. If omitted, defaults to false.
* **_trees_** (list of objects): a list of local directory trees to be embedded in the config. Ownership is not preserved. File modes are set to 0755 if the local file is executable or 0644 otherwise. Attributes of files, directories, and symlinks can be overridden by creating a corresponding entry in the `files`, `directories`, or `links` section; such `files` entries must omit `contents` and such `links` entries must omit `target`.
* **local** (string): the base of the local directory tree, relative to the directory specified by the `--files-dir` command-line argument.
* **_path_** (string): the path of the tree within the target system. Defaults to `/`.
Expand Down
146 changes: 146 additions & 0 deletions docs/config-fiot-v1_1.md

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions docs/config-fiot-v1_1-exp.md → docs/config-fiot-v1_2-exp.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
# This file is automatically generated from internal/doc and Ignition's
# config/doc. Do not edit.
title: Fedora IoT v1.1.0-experimental
title: Fedora IoT v1.2.0-experimental
parent: Configuration specifications
nav_order: 250
---

# Fedora IoT Specification v1.1.0-experimental
# Fedora IoT Specification v1.2.0-experimental

**Note: This configuration is experimental and has not been stabilized. It is subject to change without warning or announcement.**

Expand All @@ -15,7 +15,7 @@ The Fedora IoT configuration is a YAML document conforming to the following spec
<div id="spec-docs"></div>

* **variant** (string): used to differentiate configs for different operating systems. Must be `%VARIANT%` for this specification.
* **version** (string): the semantic version of the spec for this document. This document is for version `%VERSION%` and generates Ignition configs with version `3.5.0-experimental`.
* **version** (string): the semantic version of the spec for this document. This document is for version `%VERSION%` and generates Ignition configs with version `3.6.0-experimental`.
* **_ignition_** (object): metadata about the configuration itself.
* **_config_** (object): options related to the configuration.
* **_merge_** (list of objects): a list of the configs to be merged to the current config.
Expand Down
208 changes: 208 additions & 0 deletions docs/config-flatcar-v1_2.md

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
# This file is automatically generated from internal/doc and Ignition's
# config/doc. Do not edit.
title: Flatcar v1.2.0-experimental
title: Flatcar v1.3.0-experimental
parent: Configuration specifications
nav_order: 100
---

# Flatcar Specification v1.2.0-experimental
# Flatcar Specification v1.3.0-experimental

**Note: This configuration is experimental and has not been stabilized. It is subject to change without warning or announcement.**

Expand All @@ -15,7 +15,7 @@ The Flatcar configuration is a YAML document conforming to the following specifi
<div id="spec-docs"></div>

* **variant** (string): used to differentiate configs for different operating systems. Must be `flatcar` for this specification.
* **version** (string): the semantic version of the spec for this document. This document is for version `1.2.0-experimental` and generates Ignition configs with version `3.5.0-experimental`.
* **version** (string): the semantic version of the spec for this document. This document is for version `1.3.0-experimental` and generates Ignition configs with version `3.6.0-experimental`.
* **_ignition_** (object): metadata about the configuration itself.
* **_config_** (object): options related to the configuration.
* **_merge_** (list of objects): a list of the configs to be merged to the current config.
Expand Down
4 changes: 2 additions & 2 deletions docs/config-openshift-v4_18-exp.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The OpenShift configuration is a YAML document conforming to the following speci
<div id="spec-docs"></div>

* **variant** (string): used to differentiate configs for different operating systems. Must be `openshift` for this specification.
* **version** (string): the semantic version of the spec for this document. This document is for version `4.18.0-experimental` and generates Ignition configs with version `3.5.0-experimental`.
* **version** (string): the semantic version of the spec for this document. This document is for version `4.18.0-experimental` and generates Ignition configs with version `3.6.0-experimental`.
* **metadata** (object): metadata about the generated MachineConfig resource. Respected when rendering to a MachineConfig, ignored when rendering directly to an Ignition config.
* **name** (string): a unique [name](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names) for this MachineConfig resource.
* **labels** (object): string key/value pairs to apply as [Kubernetes labels](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/) to this MachineConfig resource. `machineconfiguration.openshift.io/role` is required.
Expand Down Expand Up @@ -138,7 +138,7 @@ The OpenShift configuration is a YAML document conforming to the following speci
* **config** (string): the clevis configuration JSON.
* **_needs_network_** (boolean): whether or not the device requires networking.
* **_cex_** (object): describes the IBM Crypto Express (CEX) card configuration for the luks device.
* **_enabled_** (boolean): whether or not to use a CEX secure key to encrypt the luks device.
* **_enabled_** (boolean): whether or not to enable cex compatibility for luks. If omitted, defaults to false.
* **_trees_** (list of objects): a list of local directory trees to be embedded in the config. Symlinks must not be present. Ownership is not preserved. File modes are set to 0755 if the local file is executable or 0644 otherwise. File attributes can be overridden by creating a corresponding entry in the `files` section; such entries must omit `contents`.
* **local** (string): the base of the local directory tree, relative to the directory specified by the `--files-dir` command-line argument.
* **_path_** (string): the path of the tree within the target system. Defaults to `/`.
Expand Down
Loading

0 comments on commit b626e3c

Please sign in to comment.