Fix bug in var doc gen (#1378)

awslabs · Aug 7, 2023 · bf391c8 · bf391c8
1 parent 30ccd21
commit bf391c8
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 31 deletions.
diff --git a/doc/USER_GUIDE.md b/doc/USER_GUIDE.md
@@ -23,7 +23,7 @@ Default values for most variables are defined in [a default variable file](eks-w
 Users have the following options for specifying their own values:
 
 1. Provide a variable file with the `PACKER_VARIABLE_FILE` argument to `make`. Values in this file will override values in the default variable file. Your variable file does not need to include all possible variables, as it will be merged with the default variable file.
-2. Pass a key-value pair for any template variable to `make`. These values will override any values that were specified with the first method. In the table below, these variables have a default value of "None".
+2. Pass a key-value pair for any template variable to `make`. These values will override any values that were specified with the first method. In the table below, these variables have a default value of *None*.
 
 > **Note**
 > Some variables (such as `arch` and `kubernetes_version`) do not have a sensible, static default, and are satisfied by the Makefile.
@@ -34,45 +34,45 @@ Users have the following options for specifying their own values:
 | Variable | Default value | Description |
 | - | - | - |
 | `additional_yum_repos` | `""` |  |
-| `ami_component_description` | ```{{user `remote_folder`}}/worker``` |  |
-| `ami_description` | ```{{user `remote_folder`}}/worker``` |  |
-| `ami_name` | None |  |
+| `ami_component_description` | ```(k8s: {{ user `kubernetes_version` }}, docker: {{ user `docker_version` }}, containerd: {{ user `containerd_version` }})``` |  |
+| `ami_description` | ```EKS Kubernetes Worker AMI with AmazonLinux2 image``` |  |
+| `ami_name` | *None* |  |
 | `ami_regions` | `""` |  |
 | `ami_users` | `""` |  |
-| `arch` | None |  |
+| `arch` | *None* |  |
 | `associate_public_ip_address` | `""` |  |
-| `aws_access_key_id` | ```{{user `remote_folder`}}/worker``` |  |
-| `aws_region` | ```{{user `remote_folder`}}/worker``` |  |
-| `aws_secret_access_key` | ```{{user `remote_folder`}}/worker``` |  |
-| `aws_session_token` | ```{{user `remote_folder`}}/worker``` |  |
-| `binary_bucket_name` | ```{{user `remote_folder`}}/worker``` |  |
-| `binary_bucket_region` | ```{{user `remote_folder`}}/worker``` |  |
-| `cache_container_images` | ```{{user `remote_folder`}}/worker``` |  |
-| `cni_plugin_version` | ```{{user `remote_folder`}}/worker``` |  |
-| `containerd_version` | ```{{user `remote_folder`}}/worker``` |  |
-| `creator` | ```{{user `remote_folder`}}/worker``` |  |
-| `docker_version` | ```{{user `remote_folder`}}/worker``` |  |
-| `encrypted` | ```{{user `remote_folder`}}/worker``` |  |
-| `instance_type` | None |  |
+| `aws_access_key_id` | ```{{env `AWS_ACCESS_KEY_ID`}}``` |  |
+| `aws_region` | ```us-west-2``` |  |
+| `aws_secret_access_key` | ```{{env `AWS_SECRET_ACCESS_KEY`}}``` |  |
+| `aws_session_token` | ```{{env `AWS_SESSION_TOKEN`}}``` |  |
+| `binary_bucket_name` | ```amazon-eks``` |  |
+| `binary_bucket_region` | ```us-west-2``` |  |
+| `cache_container_images` | ```false``` |  |
+| `cni_plugin_version` | ```v1.2.0``` |  |
+| `containerd_version` | ```1.6.*``` |  |
+| `creator` | ```{{env `USER`}}``` |  |
+| `docker_version` | ```20.10.23-1.amzn2.0.1``` |  |
+| `encrypted` | ```false``` |  |
+| `instance_type` | *None* |  |
 | `kernel_version` | `""` |  |
 | `kms_key_id` | `""` |  |
-| `kubernetes_build_date` | None |  |
-| `kubernetes_version` | None |  |
-| `launch_block_device_mappings_volume_size` | ```{{user `remote_folder`}}/worker``` |  |
-| `pause_container_version` | ```{{user `remote_folder`}}/worker``` |  |
-| `pull_cni_from_github` | ```{{user `remote_folder`}}/worker``` |  |
-| `remote_folder` | ```{{user `remote_folder`}}/worker``` | Directory path for shell provisioner scripts on the builder instance |
-| `runc_version` | ```{{user `remote_folder`}}/worker``` |  |
+| `kubernetes_build_date` | *None* |  |
+| `kubernetes_version` | *None* |  |
+| `launch_block_device_mappings_volume_size` | ```4``` |  |
+| `pause_container_version` | ```3.5``` |  |
+| `pull_cni_from_github` | ```true``` |  |
+| `remote_folder` | ```/tmp``` | Directory path for shell provisioner scripts on the builder instance |
+| `runc_version` | ```1.1.5-1.amzn2``` |  |
 | `security_group_id` | `""` |  |
-| `source_ami_filter_name` | ```{{user `remote_folder`}}/worker``` |  |
+| `source_ami_filter_name` | ```amzn2-ami-minimal-hvm-*``` |  |
 | `source_ami_id` | `""` |  |
-| `source_ami_owners` | ```{{user `remote_folder`}}/worker``` |  |
+| `source_ami_owners` | ```137112412989``` |  |
 | `ssh_interface` | `""` |  |
-| `ssh_username` | ```{{user `remote_folder`}}/worker``` |  |
-| `ssm_agent_version` | ```{{user `remote_folder`}}/worker``` |  |
+| `ssh_username` | ```ec2-user``` |  |
+| `ssm_agent_version` | ```latest``` |  |
 | `subnet_id` | `""` |  |
 | `temporary_security_group_source_cidrs` | `""` |  |
-| `volume_type` | ```{{user `remote_folder`}}/worker``` |  |
+| `volume_type` | ```gp2``` |  |
 | `working_dir` | ```{{user `remote_folder`}}/worker``` | Directory path for ephemeral resources on the builder instance |
 <!-- template-variable-table-boundary -->
 

diff --git a/hack/generate-template-variable-doc.py b/hack/generate-template-variable-doc.py
@@ -47,7 +47,9 @@
         if val == "":
             val = f"`\"\"`"
         else:
-            val = f"```{default_val}```"
+            val = f"```{val}```"
+    else:
+        val = "*None*"
     description = ""
     if var in existing_descriptions:
         description = existing_descriptions[var]