From 096bd34049863cb935f295ec60fb4029feb98bba Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Iago=20L=C3=B3pez=20Galeiras?= Date: Mon, 30 Mar 2020 13:21:36 +0200 Subject: [PATCH] docs: clarify values for ssh_pubkeys They should be the full public key and this is not obvious. Also, show a more descriptive value for the quickstart examples. --- docs/configuration-reference/platforms/aws.md | 4 +- .../platforms/baremetal.md | 40 +++++++++---------- .../platforms/packet.md | 2 +- docs/quickstarts/aws.md | 2 +- docs/quickstarts/packet.md | 2 +- 5 files changed, 25 insertions(+), 25 deletions(-) diff --git a/docs/configuration-reference/platforms/aws.md b/docs/configuration-reference/platforms/aws.md index 2874bf13a..50fe7abba 100644 --- a/docs/configuration-reference/platforms/aws.md +++ b/docs/configuration-reference/platforms/aws.md @@ -178,7 +178,7 @@ worker_pool "my-worker-pool" { | `os_version` | Flatcar Container Linux version to install. Version such as "2303.3.1" or "current". | "current" | false | | `dns_zone` | Route 53 DNS Zone. | - | true | | `dns_zone_id` | Route 53 DNS Zone ID. | - | true | -| `ssh_pubkeys` | SSH public keys for user `core`. | - | true | +| `ssh_pubkeys` | List of SSH public keys for user `core`. Each element must be specified in a valid OpenSSH public key format, as defined in RFC 4253 Section 6.6, e.g. "ssh-rsa AAAAB3N...". | - | true | | `controller_count` | Number of controller nodes. | 1 | false | | `controller_type` | AWS instance type for controllers. | "t3.small" | false | | `controller_clc_snippets` | Controller Flatcar Container Linux Config snippets. | [] | false | @@ -197,7 +197,7 @@ worker_pool "my-worker-pool" { | `worker_pool` | Configuration block for worker pools. There can be more than one. **NOTE**: worker pool name must be unique per DNS zone and region. | - | true | | `worker_pool.count` | Number of workers in the worker pool. Can be changed afterwards to add or delete workers. | - | true | | `worker_pool.instance_type` | AWS instance type for worker nodes. | "t3.small" | false | -| `worker_pool.ssh_pubkeys` | SSH public keys for user `core`. | - | true | +| `worker_pool.ssh_pubkeys` | List of SSH public keys for user `core`. Each element must be specified in a valid OpenSSH public key format, as defined in RFC 4253 Section 6.6, e.g. "ssh-rsa AAAAB3N...". | - | true | | `worker_pool.os_channel` | Flatcar Container Linux channel to install from (stable, beta, alpha, edge). | "stable" | false | | `worker_pool.os_version` | Flatcar Container Linux version to install. Version such as "2303.3.1" or "current". | "current" | false | | `worker_pool.disk_size` | Size of the EBS volume in GB. | 40 | false | diff --git a/docs/configuration-reference/platforms/baremetal.md b/docs/configuration-reference/platforms/baremetal.md index 14079f9a6..8c247f740 100644 --- a/docs/configuration-reference/platforms/baremetal.md +++ b/docs/configuration-reference/platforms/baremetal.md @@ -111,26 +111,26 @@ os_version = var.custom_default_os_version ## Attribute reference -| Argument | Description | Default | Required | -|-----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------------:|:--------:| -| `asset_dir` | Location where Lokomotive stores cluster assets. | - | true | -| `cached_install` | Whether the operating system should PXE boot and install from matchbox /assets cache. Note that the admin must have downloaded the `os_version` into matchbox assets. | "false" | false | -| `cluster_name` | Name of the cluster. | - | true | -| `controller_domains` | Ordered list of controller FQDNs. Example: ["node1.example.com"] | - | true | -| `controller_macs` | Ordered list of controller identifying MAC addresses. Example: ["52:54:00:a1:9c:ae"] | - | true | -| `controller_names` | Ordered list of controller names. Example: ["node1"] | - | true | -| `k8s_domain_name` | Controller DNS name which resolves to a controller instance. Workers and kubeconfig's will communicate with this endpoint. Example: "cluster.example.com" | - | true | -| `matchbox_ca_path` | Path to the CA to verify and authenticate client certificates. | - | true | -| `matchbox_client_cert_path` | Path to the server TLS certificate file. | - | true | -| `matchbox_client_key_path` | Path to the server TLS key file. | - | true | -| `matchbox_endpoint` | Matchbox API endpoint. | - | true | -| `matchbox_http_endpoint` | Matchbox HTTP read-only endpoint. Example: "http://matchbox.example.com:8080" | - | true | -| `worker_names` | Ordered list of worker names. Example: ["node2", "node3"] | - | true | -| `worker_macs` | Ordered list of worker identifying MAC addresses. Example ["52:54:00:b2:2f:86", "52:54:00:c3:61:77"] | - | true | -| `worker_domains` | Ordered list of worker FQDNs. Example ["node2.example.com", "node3.example.com"] | - | true | -| `ssh_pubkeys` | SSH public keys for user `core`. | - | true | -| `os_version` | Flatcar Container Linux version to install. Version such as "2303.3.1" or "current". | "current" | false | -| `os_channel` | Flatcar Container Linux channel to install from ("flatcar-stable", "flatcar-beta", "flatcar-alpha", "flatcar-edge"). | "flatcar-stable" | false | +| Argument | Description | Default | Required | +|-----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------------:|:--------:| +| `asset_dir` | Location where Lokomotive stores cluster assets. | - | true | +| `cached_install` | Whether the operating system should PXE boot and install from matchbox /assets cache. Note that the admin must have downloaded the `os_version` into matchbox assets. | "false" | false | +| `cluster_name` | Name of the cluster. | - | true | +| `controller_domains` | Ordered list of controller FQDNs. Example: ["node1.example.com"] | - | true | +| `controller_macs` | Ordered list of controller identifying MAC addresses. Example: ["52:54:00:a1:9c:ae"] | - | true | +| `controller_names` | Ordered list of controller names. Example: ["node1"] | - | true | +| `k8s_domain_name` | Controller DNS name which resolves to a controller instance. Workers and kubeconfig's will communicate with this endpoint. Example: "cluster.example.com" | - | true | +| `matchbox_ca_path` | Path to the CA to verify and authenticate client certificates. | - | true | +| `matchbox_client_cert_path` | Path to the server TLS certificate file. | - | true | +| `matchbox_client_key_path` | Path to the server TLS key file. | - | true | +| `matchbox_endpoint` | Matchbox API endpoint. | - | true | +| `matchbox_http_endpoint` | Matchbox HTTP read-only endpoint. Example: "http://matchbox.example.com:8080" | - | true | +| `worker_names` | Ordered list of worker names. Example: ["node2", "node3"] | - | true | +| `worker_macs` | Ordered list of worker identifying MAC addresses. Example ["52:54:00:b2:2f:86", "52:54:00:c3:61:77"] | - | true | +| `worker_domains` | Ordered list of worker FQDNs. Example ["node2.example.com", "node3.example.com"] | - | true | +| `ssh_pubkeys` | List of SSH public keys for user `core`. Each element must be specified in a valid OpenSSH public key format, as defined in RFC 4253 Section 6.6, e.g. "ssh-rsa AAAAB3N...". | - | true | +| `os_version` | Flatcar Container Linux version to install. Version such as "2303.3.1" or "current". | "current" | false | +| `os_channel` | Flatcar Container Linux channel to install from ("flatcar-stable", "flatcar-beta", "flatcar-alpha", "flatcar-edge"). | "flatcar-stable" | false | ## Applying diff --git a/docs/configuration-reference/platforms/packet.md b/docs/configuration-reference/platforms/packet.md index 58f2c2dc2..107a2fe83 100644 --- a/docs/configuration-reference/platforms/packet.md +++ b/docs/configuration-reference/platforms/packet.md @@ -194,7 +194,7 @@ node_type = var.custom_default_worker_type | `dns.provider.manual` | Manual DNS configuration. | - | false | | `facility` | Packet facility to use for deploying the cluster. | - | false | | `project_id` | Packet project ID. | - | true | -| `ssh_pubkeys` | SSH public keys for user `core`. | - | true | +| `ssh_pubkeys` | List of SSH public keys for user `core`. Each element must be specified in a valid OpenSSH public key format, as defined in RFC 4253 Section 6.6, e.g. "ssh-rsa AAAAB3N...". | - | true | | `os_arch` | Flatcar Container Linux architecture to install (amd64, arm64). | "amd64" | false | | `os_channel` | Flatcar Container Linux channel to install from (stable, beta, alpha, edge). | "stable" | false | | `os_version` | Flatcar Container Linux version to install. Version such as "2303.3.1" or "current". | "current" | false | diff --git a/docs/quickstarts/aws.md b/docs/quickstarts/aws.md index 2ddd563a0..9d711a407 100644 --- a/docs/quickstarts/aws.md +++ b/docs/quickstarts/aws.md @@ -95,7 +95,7 @@ defined in the configuration file. ```console #lokocfg.vars -ssh_public_keys = ["public-ssh-key-1", "public-ssh-key-2", ...] +ssh_public_keys = ["ssh-rsa AAAAB3Nz...", "ssh-rsa AAAAB3Nz...", ...] state_s3_bucket = "name-of-the-s3-bucket-to-store-the-cluster-state" lock_dynamodb_table = "name-of-the-dynamodb-table-for-state-locking" diff --git a/docs/quickstarts/packet.md b/docs/quickstarts/packet.md index e4e0efe80..b961d245f 100644 --- a/docs/quickstarts/packet.md +++ b/docs/quickstarts/packet.md @@ -105,7 +105,7 @@ defined in the configuration file. #lokocfg.vars packet_project_id = "PACKET_PROJECT_ID" -ssh_public_keys = ["public-ssh-key-1", "public-ssh-key-2", ...] +ssh_public_keys = ["ssh-rsa AAAAB3Nz...", "ssh-rsa AAAAB3Nz...", ...] state_s3_bucket = "name-of-the-s3-bucket-to-store-the-cluster-state" lock_dynamodb_table = "name-of-the-dynamodb-table-for-state-locking"