docs: remove references to init nodes

Init nodes were deprecated in v1.0 so it makes sense
to remove the documentation about them and consign
them to the past!

Signed-off-by: Tim Jones <tim.jones@siderolabs.com>
This commit is contained in:
Tim Jones 2022-04-26 21:56:07 +02:00
parent 1973095d14
commit c456dbcb93
No known key found for this signature in database
GPG Key ID: A2A702DD5B689F45
4 changed files with 3 additions and 11 deletions

View File

@ -606,12 +606,6 @@ type MachineConfig struct {
// description: |
// Defines the role of the machine within the cluster.
//
// **Init**
//
// Init node type designates the first control plane node to come up.
// You can think of it like a bootstrap node.
// This node will perform the initial steps to bootstrap the cluster -- generation of TLS assets, starting of the control plane, etc.
//
// **Control Plane**
//
// Control Plane node type designates the node as a control plane member.
@ -624,7 +618,6 @@ type MachineConfig struct {
//
// This node type was previously known as "join"; that value is still supported but deprecated.
// values:
// - "init"
// - "controlplane"
// - "worker"
MachineType string `yaml:"type"`

View File

@ -142,10 +142,9 @@ func init() {
MachineConfigDoc.Fields[0].Name = "type"
MachineConfigDoc.Fields[0].Type = "string"
MachineConfigDoc.Fields[0].Note = ""
MachineConfigDoc.Fields[0].Description = "Defines the role of the machine within the cluster.\n\n**Init**\n\nInit node type designates the first control plane node to come up.\nYou can think of it like a bootstrap node.\nThis node will perform the initial steps to bootstrap the cluster -- generation of TLS assets, starting of the control plane, etc.\n\n**Control Plane**\n\nControl Plane node type designates the node as a control plane member.\nThis means it will host etcd along with the Kubernetes master components such as API Server, Controller Manager, Scheduler.\n\n**Worker**\n\nWorker node type designates the node as a worker node.\nThis means it will be an available compute node for scheduling workloads.\n\nThis node type was previously known as \"join\"; that value is still supported but deprecated."
MachineConfigDoc.Fields[0].Description = "Defines the role of the machine within the cluster.\n\n**Control Plane**\n\nControl Plane node type designates the node as a control plane member.\nThis means it will host etcd along with the Kubernetes master components such as API Server, Controller Manager, Scheduler.\n\n**Worker**\n\nWorker node type designates the node as a worker node.\nThis means it will be an available compute node for scheduling workloads.\n\nThis node type was previously known as \"join\"; that value is still supported but deprecated."
MachineConfigDoc.Fields[0].Comments[encoder.LineComment] = "Defines the role of the machine within the cluster."
MachineConfigDoc.Fields[0].Values = []string{
"init",
"controlplane",
"worker",
}

View File

@ -75,7 +75,7 @@ install:
| Field | Type | Description | Value(s) |
|-------|------|-------------|----------|
|`type` |string |<details><summary>Defines the role of the machine within the cluster.</summary><br />**Init**<br /><br />Init node type designates the first control plane node to come up.<br />You can think of it like a bootstrap node.<br />This node will perform the initial steps to bootstrap the cluster -- generation of TLS assets, starting of the control plane, etc.<br /><br />**Control Plane**<br /><br />Control Plane node type designates the node as a control plane member.<br />This means it will host etcd along with the Kubernetes master components such as API Server, Controller Manager, Scheduler.<br /><br />**Worker**<br /><br />Worker node type designates the node as a worker node.<br />This means it will be an available compute node for scheduling workloads.<br /><br />This node type was previously known as "join"; that value is still supported but deprecated.</details> |`init`<br />`controlplane`<br />`worker`<br /> |
|`type` |string |<details><summary>Defines the role of the machine within the cluster.</summary><br />**Control Plane**<br /><br />Control Plane node type designates the node as a control plane member.<br />This means it will host etcd along with the Kubernetes master components such as API Server, Controller Manager, Scheduler.<br /><br />**Worker**<br /><br />Worker node type designates the node as a worker node.<br />This means it will be an available compute node for scheduling workloads.<br /><br />This node type was previously known as "join"; that value is still supported but deprecated.</details> |`controlplane`<br />`worker`<br /> |
|`token` |string |<details><summary>The `token` is used by a machine to join the PKI of the cluster.</summary>Using this token, a machine will create a certificate signing request (CSR), and request a certificate that will be used as its' identity.</details> <details><summary>Show example(s)</summary>{{< highlight yaml >}}
token: 328hom.uqjzh6jnn2eie9oi
{{< /highlight >}}</details> | |

View File

@ -75,7 +75,7 @@ install:
| Field | Type | Description | Value(s) |
|-------|------|-------------|----------|
|`type` |string |<details><summary>Defines the role of the machine within the cluster.</summary><br />**Init**<br /><br />Init node type designates the first control plane node to come up.<br />You can think of it like a bootstrap node.<br />This node will perform the initial steps to bootstrap the cluster -- generation of TLS assets, starting of the control plane, etc.<br /><br />**Control Plane**<br /><br />Control Plane node type designates the node as a control plane member.<br />This means it will host etcd along with the Kubernetes master components such as API Server, Controller Manager, Scheduler.<br /><br />**Worker**<br /><br />Worker node type designates the node as a worker node.<br />This means it will be an available compute node for scheduling workloads.<br /><br />This node type was previously known as "join"; that value is still supported but deprecated.</details> |`init`<br />`controlplane`<br />`worker`<br /> |
|`type` |string |<details><summary>Defines the role of the machine within the cluster.</summary><br />**Control Plane**<br /><br />Control Plane node type designates the node as a control plane member.<br />This means it will host etcd along with the Kubernetes master components such as API Server, Controller Manager, Scheduler.<br /><br />**Worker**<br /><br />Worker node type designates the node as a worker node.<br />This means it will be an available compute node for scheduling workloads.<br /><br />This node type was previously known as "join"; that value is still supported but deprecated.</details> |`controlplane`<br />`worker`<br /> |
|`token` |string |<details><summary>The `token` is used by a machine to join the PKI of the cluster.</summary>Using this token, a machine will create a certificate signing request (CSR), and request a certificate that will be used as its' identity.</details> <details><summary>Show example(s)</summary>{{< highlight yaml >}}
token: 328hom.uqjzh6jnn2eie9oi
{{< /highlight >}}</details> | |