Skip to content

Commit

Permalink
Updates readmes for latest terraform-docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@lorengordon
lorengordon committed Jan 7, 2025
1 parent 2cb53b3 commit 2c4a2b0
Showing 1 changed file with 16 additions and 16 deletions.
32 changes: 16 additions & 16 deletions spel/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,27 +7,27 @@
| <a name="input_spel_version"></a> [spel\_version](#input\_spel\_version) | Version appended to the name of the built images | `string` | n/a | yes |
| <a name="input_amigen8_bootdev_mult"></a> [amigen8\_bootdev\_mult](#input\_amigen8\_bootdev\_mult) | Factor by which to increase /boot's size on "special" distros (like OL8) | `string` | `"1.2"` | no |
| <a name="input_amigen8_bootdev_size"></a> [amigen8\_bootdev\_size](#input\_amigen8\_bootdev\_size) | Size, in MiB, to make the /boot partition (this will be multiplied by the 'amigen8\_bootdev\_mult' value for Oracle Linux images) | `string` | `"1024"` | no |
| <a name="input_amigen8_extra_rpms"></a> [amigen8\_extra\_rpms](#input\_amigen8\_extra\_rpms) | List of package specs (rpm names or URLs to .rpm files) to install to the EL8 builders and images | `list(string)` | <pre>[<br> "python39",<br> "python39-pip",<br> "python39-setuptools",<br> "crypto-policies-scripts",<br> "spel-release",<br> "spel-dod-certs",<br> "spel-wcf-certs",<br> "amazon-ec2-net-utils",<br> "ec2-hibinit-agent",<br> "ec2-instance-connect",<br> "ec2-instance-connect-selinux",<br> "ec2-utils",<br> "https://s3.amazonaws.com/ec2-downloads-windows/SSMAgent/latest/linux_amd64/amazon-ssm-agent.rpm"<br>]</pre> | no |
| <a name="input_amigen8_extra_rpms"></a> [amigen8\_extra\_rpms](#input\_amigen8\_extra\_rpms) | List of package specs (rpm names or URLs to .rpm files) to install to the EL8 builders and images | `list(string)` | <pre>[<br/> "python39",<br/> "python39-pip",<br/> "python39-setuptools",<br/> "crypto-policies-scripts",<br/> "spel-release",<br/> "spel-dod-certs",<br/> "spel-wcf-certs",<br/> "amazon-ec2-net-utils",<br/> "ec2-hibinit-agent",<br/> "ec2-instance-connect",<br/> "ec2-instance-connect-selinux",<br/> "ec2-utils",<br/> "https://s3.amazonaws.com/ec2-downloads-windows/SSMAgent/latest/linux_amd64/amazon-ssm-agent.rpm"<br/>]</pre> | no |
| <a name="input_amigen8_filesystem_label"></a> [amigen8\_filesystem\_label](#input\_amigen8\_filesystem\_label) | Label for the root filesystem when creating bare partitions for EL8 images | `string` | `""` | no |
| <a name="input_amigen8_package_groups"></a> [amigen8\_package\_groups](#input\_amigen8\_package\_groups) | List of yum repo groups to install into EL8 images | `list(string)` | <pre>[<br> "core"<br>]</pre> | no |
| <a name="input_amigen8_package_groups"></a> [amigen8\_package\_groups](#input\_amigen8\_package\_groups) | List of yum repo groups to install into EL8 images | `list(string)` | <pre>[<br/> "core"<br/>]</pre> | no |
| <a name="input_amigen8_package_manifest"></a> [amigen8\_package\_manifest](#input\_amigen8\_package\_manifest) | File containing a list of RPMs to use as the build manifest for EL8 images | `string` | `""` | no |
| <a name="input_amigen8_repo_names"></a> [amigen8\_repo\_names](#input\_amigen8\_repo\_names) | List of yum repo names to enable in the EL8 builders and EL8 images | `list(string)` | <pre>[<br> "spel"<br>]</pre> | no |
| <a name="input_amigen8_repo_sources"></a> [amigen8\_repo\_sources](#input\_amigen8\_repo\_sources) | List of yum package refs (names or urls to .rpm files) that install yum repo definitions in EL8 builders and images | `list(string)` | <pre>[<br> "https://dl.fedoraproject.org/pub/epel/epel-release-latest-8.noarch.rpm",<br> "https://spel-packages.cloudarmor.io/spel-packages/repo/spel-release-latest-8.noarch.rpm"<br>]</pre> | no |
| <a name="input_amigen8_repo_names"></a> [amigen8\_repo\_names](#input\_amigen8\_repo\_names) | List of yum repo names to enable in the EL8 builders and EL8 images | `list(string)` | <pre>[<br/> "spel"<br/>]</pre> | no |
| <a name="input_amigen8_repo_sources"></a> [amigen8\_repo\_sources](#input\_amigen8\_repo\_sources) | List of yum package refs (names or urls to .rpm files) that install yum repo definitions in EL8 builders and images | `list(string)` | <pre>[<br/> "https://dl.fedoraproject.org/pub/epel/epel-release-latest-8.noarch.rpm",<br/> "https://spel-packages.cloudarmor.io/spel-packages/repo/spel-release-latest-8.noarch.rpm"<br/>]</pre> | no |
| <a name="input_amigen8_source_branch"></a> [amigen8\_source\_branch](#input\_amigen8\_source\_branch) | Branch that will be checked out when cloning AMIgen8 | `string` | `"master"` | no |
| <a name="input_amigen8_source_url"></a> [amigen8\_source\_url](#input\_amigen8\_source\_url) | URL that will be used to clone AMIgen8 | `string` | `"https://github.com/plus3it/AMIgen8.git"` | no |
| <a name="input_amigen8_storage_layout"></a> [amigen8\_storage\_layout](#input\_amigen8\_storage\_layout) | List of colon-separated tuples (mount:name:size) that describe the desired partitions for LVM-partitioned disks on EL8 images | `list(string)` | <pre>[<br> "/:rootVol:6",<br> "swap:swapVol:2",<br> "/home:homeVol:1",<br> "/var:varVol:2",<br> "/var/tmp:varTmpVol:2",<br> "/var/log:logVol:2",<br> "/var/log/audit:auditVol:100%FREE"<br>]</pre> | no |
| <a name="input_amigen8_storage_layout"></a> [amigen8\_storage\_layout](#input\_amigen8\_storage\_layout) | List of colon-separated tuples (mount:name:size) that describe the desired partitions for LVM-partitioned disks on EL8 images | `list(string)` | <pre>[<br/> "/:rootVol:6",<br/> "swap:swapVol:2",<br/> "/home:homeVol:1",<br/> "/var:varVol:2",<br/> "/var/tmp:varTmpVol:2",<br/> "/var/log:logVol:2",<br/> "/var/log/audit:auditVol:100%FREE"<br/>]</pre> | no |
| <a name="input_amigen9_boot_dev_label"></a> [amigen9\_boot\_dev\_label](#input\_amigen9\_boot\_dev\_label) | Filesystem-label to apply to the '/boot' partition | `string` | `"boot_disk"` | no |
| <a name="input_amigen9_boot_dev_size"></a> [amigen9\_boot\_dev\_size](#input\_amigen9\_boot\_dev\_size) | Size of the partition hosting the '/boot' partition | `number` | `768` | no |
| <a name="input_amigen9_boot_dev_size_mult"></a> [amigen9\_boot\_dev\_size\_mult](#input\_amigen9\_boot\_dev\_size\_mult) | Factor by which to increase /boot's size on "special" distros (like OL9) | `number` | `"1.1"` | no |
| <a name="input_amigen9_extra_rpms"></a> [amigen9\_extra\_rpms](#input\_amigen9\_extra\_rpms) | List of package specs (rpm names or URLs to .rpm files) to install to the EL9 builders and images | `list(string)` | <pre>[<br> "crypto-policies-scripts",<br> "spel-release",<br> "spel-dod-certs",<br> "spel-wcf-certs",<br> "amazon-ec2-net-utils",<br> "ec2-hibinit-agent",<br> "ec2-utils",<br> "https://s3.amazonaws.com/ec2-downloads-windows/SSMAgent/latest/linux_amd64/amazon-ssm-agent.rpm"<br>]</pre> | no |
| <a name="input_amigen9_extra_rpms"></a> [amigen9\_extra\_rpms](#input\_amigen9\_extra\_rpms) | List of package specs (rpm names or URLs to .rpm files) to install to the EL9 builders and images | `list(string)` | <pre>[<br/> "crypto-policies-scripts",<br/> "spel-release",<br/> "spel-dod-certs",<br/> "spel-wcf-certs",<br/> "amazon-ec2-net-utils",<br/> "ec2-hibinit-agent",<br/> "ec2-utils",<br/> "https://s3.amazonaws.com/ec2-downloads-windows/SSMAgent/latest/linux_amd64/amazon-ssm-agent.rpm"<br/>]</pre> | no |
| <a name="input_amigen9_filesystem_label"></a> [amigen9\_filesystem\_label](#input\_amigen9\_filesystem\_label) | Label for the root filesystem when creating bare partitions for EL9 images | `string` | `""` | no |
| <a name="input_amigen9_package_groups"></a> [amigen9\_package\_groups](#input\_amigen9\_package\_groups) | List of yum repo groups to install into EL9 images | `list(string)` | <pre>[<br> "core"<br>]</pre> | no |
| <a name="input_amigen9_package_groups"></a> [amigen9\_package\_groups](#input\_amigen9\_package\_groups) | List of yum repo groups to install into EL9 images | `list(string)` | <pre>[<br/> "core"<br/>]</pre> | no |
| <a name="input_amigen9_package_manifest"></a> [amigen9\_package\_manifest](#input\_amigen9\_package\_manifest) | File containing a list of RPMs to use as the build manifest for EL9 images | `string` | `""` | no |
| <a name="input_amigen9_repo_names"></a> [amigen9\_repo\_names](#input\_amigen9\_repo\_names) | List of yum repo names to enable in the EL9 builders and EL9 images | `list(string)` | <pre>[<br> "epel",<br> "spel"<br>]</pre> | no |
| <a name="input_amigen9_repo_sources"></a> [amigen9\_repo\_sources](#input\_amigen9\_repo\_sources) | List of yum package refs (names or urls to .rpm files) that install yum repo definitions in EL9 builders and images | `list(string)` | <pre>[<br> "https://dl.fedoraproject.org/pub/epel/epel-release-latest-9.noarch.rpm",<br> "https://spel-packages.cloudarmor.io/spel-packages/repo/spel-release-latest-9.noarch.rpm"<br>]</pre> | no |
| <a name="input_amigen9_repo_names"></a> [amigen9\_repo\_names](#input\_amigen9\_repo\_names) | List of yum repo names to enable in the EL9 builders and EL9 images | `list(string)` | <pre>[<br/> "epel",<br/> "spel"<br/>]</pre> | no |
| <a name="input_amigen9_repo_sources"></a> [amigen9\_repo\_sources](#input\_amigen9\_repo\_sources) | List of yum package refs (names or urls to .rpm files) that install yum repo definitions in EL9 builders and images | `list(string)` | <pre>[<br/> "https://dl.fedoraproject.org/pub/epel/epel-release-latest-9.noarch.rpm",<br/> "https://spel-packages.cloudarmor.io/spel-packages/repo/spel-release-latest-9.noarch.rpm"<br/>]</pre> | no |
| <a name="input_amigen9_source_branch"></a> [amigen9\_source\_branch](#input\_amigen9\_source\_branch) | Branch that will be checked out when cloning AMIgen9 | `string` | `"main"` | no |
| <a name="input_amigen9_source_url"></a> [amigen9\_source\_url](#input\_amigen9\_source\_url) | URL that will be used to clone AMIgen9 | `string` | `"https://github.com/plus3it/AMIgen9.git"` | no |
| <a name="input_amigen9_storage_layout"></a> [amigen9\_storage\_layout](#input\_amigen9\_storage\_layout) | List of colon-separated tuples (mount:name:size) that describe the desired partitions for LVM-partitioned disks on EL9 images | `list(string)` | <pre>[<br> "/:rootVol:6",<br> "swap:swapVol:2",<br> "/home:homeVol:1",<br> "/var:varVol:2",<br> "/var/tmp:varTmpVol:2",<br> "/var/log:logVol:2",<br> "/var/log/audit:auditVol:100%FREE"<br>]</pre> | no |
| <a name="input_amigen9_storage_layout"></a> [amigen9\_storage\_layout](#input\_amigen9\_storage\_layout) | List of colon-separated tuples (mount:name:size) that describe the desired partitions for LVM-partitioned disks on EL9 images | `list(string)` | <pre>[<br/> "/:rootVol:6",<br/> "swap:swapVol:2",<br/> "/home:homeVol:1",<br/> "/var:varVol:2",<br/> "/var/tmp:varTmpVol:2",<br/> "/var/log:logVol:2",<br/> "/var/log/audit:auditVol:100%FREE"<br/>]</pre> | no |
| <a name="input_amigen9_uefi_dev_label"></a> [amigen9\_uefi\_dev\_label](#input\_amigen9\_uefi\_dev\_label) | Filesystem-label to apply to the '/boot/efi' partition | `string` | `"UEFI_DISK"` | no |
| <a name="input_amigen9_uefi_dev_size"></a> [amigen9\_uefi\_dev\_size](#input\_amigen9\_uefi\_dev\_size) | Size of the partition hosting the '/boot/efi' partition | `number` | `128` | no |
| <a name="input_amigen_amiutils_source_url"></a> [amigen\_amiutils\_source\_url](#input\_amigen\_amiutils\_source\_url) | URL of the AMI Utils repo to be cloned using git, containing AWS utility rpms that will be installed to the AMIs | `string` | `""` | no |
Expand All @@ -43,14 +43,14 @@
| <a name="input_aws_force_deregister"></a> [aws\_force\_deregister](#input\_aws\_force\_deregister) | Force deregister an existing AMI if one with the same name already exists | `bool` | `false` | no |
| <a name="input_aws_instance_type"></a> [aws\_instance\_type](#input\_aws\_instance\_type) | EC2 instance type to use while building the AMIs | `string` | `"t3.2xlarge"` | no |
| <a name="input_aws_region"></a> [aws\_region](#input\_aws\_region) | Name of the AWS region in which to launch the EC2 instance to create the AMIs | `string` | `"us-east-1"` | no |
| <a name="input_aws_source_ami_filter_centos9stream_hvm"></a> [aws\_source\_ami\_filter\_centos9stream\_hvm](#input\_aws\_source\_ami\_filter\_centos9stream\_hvm) | Object with source AMI filters for CentOS Stream 9 HVM builds | <pre>object({<br> name = string<br> owners = list(string)<br> })</pre> | <pre>{<br> "name": "CentOS Stream 9 x86_64 *,spel-bootstrap-centos-9stream-*.x86_64-gp*",<br> "owners": [<br> "125523088429",<br> "174003430611",<br> "216406534498"<br> ]<br>}</pre> | no |
| <a name="input_aws_source_ami_filter_ol8_hvm"></a> [aws\_source\_ami\_filter\_ol8\_hvm](#input\_aws\_source\_ami\_filter\_ol8\_hvm) | Object with source AMI filters for Oracle Linux 8 HVM builds | <pre>object({<br> name = string<br> owners = list(string)<br> })</pre> | <pre>{<br> "name": "OL8.*-x86_64-HVM-*,spel-bootstrap-oraclelinux-8-hvm-*.x86_64-gp*,spel-bootstrap-ol-8-*.x86_64-gp*",<br> "owners": [<br> "131827586825",<br> "174003430611",<br> "216406534498"<br> ]<br>}</pre> | no |
| <a name="input_aws_source_ami_filter_ol9_hvm"></a> [aws\_source\_ami\_filter\_ol9\_hvm](#input\_aws\_source\_ami\_filter\_ol9\_hvm) | Object with source AMI filters for Oracle Linux 9 HVM builds | <pre>object({<br> name = string<br> owners = list(string)<br> })</pre> | <pre>{<br> "name": "OL9.*-x86_64-HVM-*,spel-bootstrap-oraclelinux-9-hvm-*.x86_64-gp*,spel-bootstrap-ol-9-*.x86_64-gp*",<br> "owners": [<br> "131827586825",<br> "174003430611",<br> "216406534498"<br> ]<br>}</pre> | no |
| <a name="input_aws_source_ami_filter_rhel8_hvm"></a> [aws\_source\_ami\_filter\_rhel8\_hvm](#input\_aws\_source\_ami\_filter\_rhel8\_hvm) | Object with source AMI filters for RHEL 8 HVM builds | <pre>object({<br> name = string<br> owners = list(string)<br> })</pre> | <pre>{<br> "name": "RHEL-8.*_HVM-*-x86_64-*-Hourly*-GP*,spel-bootstrap-rhel-8-*.x86_64-gp*",<br> "owners": [<br> "309956199498",<br> "219670896067",<br> "174003430611",<br> "216406534498"<br> ]<br>}</pre> | no |
| <a name="input_aws_source_ami_filter_rhel9_hvm"></a> [aws\_source\_ami\_filter\_rhel9\_hvm](#input\_aws\_source\_ami\_filter\_rhel9\_hvm) | Object with source AMI filters for RHEL 9 HVM builds | <pre>object({<br> name = string<br> owners = list(string)<br> })</pre> | <pre>{<br> "name": "RHEL-9.*_HVM-*-x86_64-*-Hourly*-GP*,spel-bootstrap-rhel-9-*.x86_64-gp*",<br> "owners": [<br> "309956199498",<br> "219670896067",<br> "174003430611",<br> "216406534498"<br> ]<br>}</pre> | no |
| <a name="input_aws_source_ami_filter_centos9stream_hvm"></a> [aws\_source\_ami\_filter\_centos9stream\_hvm](#input\_aws\_source\_ami\_filter\_centos9stream\_hvm) | Object with source AMI filters for CentOS Stream 9 HVM builds | <pre>object({<br/> name = string<br/> owners = list(string)<br/> })</pre> | <pre>{<br/> "name": "CentOS Stream 9 x86_64 *,spel-bootstrap-centos-9stream-*.x86_64-gp*",<br/> "owners": [<br/> "125523088429",<br/> "174003430611",<br/> "216406534498"<br/> ]<br/>}</pre> | no |
| <a name="input_aws_source_ami_filter_ol8_hvm"></a> [aws\_source\_ami\_filter\_ol8\_hvm](#input\_aws\_source\_ami\_filter\_ol8\_hvm) | Object with source AMI filters for Oracle Linux 8 HVM builds | <pre>object({<br/> name = string<br/> owners = list(string)<br/> })</pre> | <pre>{<br/> "name": "OL8.*-x86_64-HVM-*,spel-bootstrap-oraclelinux-8-hvm-*.x86_64-gp*,spel-bootstrap-ol-8-*.x86_64-gp*",<br/> "owners": [<br/> "131827586825",<br/> "174003430611",<br/> "216406534498"<br/> ]<br/>}</pre> | no |
| <a name="input_aws_source_ami_filter_ol9_hvm"></a> [aws\_source\_ami\_filter\_ol9\_hvm](#input\_aws\_source\_ami\_filter\_ol9\_hvm) | Object with source AMI filters for Oracle Linux 9 HVM builds | <pre>object({<br/> name = string<br/> owners = list(string)<br/> })</pre> | <pre>{<br/> "name": "OL9.*-x86_64-HVM-*,spel-bootstrap-oraclelinux-9-hvm-*.x86_64-gp*,spel-bootstrap-ol-9-*.x86_64-gp*",<br/> "owners": [<br/> "131827586825",<br/> "174003430611",<br/> "216406534498"<br/> ]<br/>}</pre> | no |
| <a name="input_aws_source_ami_filter_rhel8_hvm"></a> [aws\_source\_ami\_filter\_rhel8\_hvm](#input\_aws\_source\_ami\_filter\_rhel8\_hvm) | Object with source AMI filters for RHEL 8 HVM builds | <pre>object({<br/> name = string<br/> owners = list(string)<br/> })</pre> | <pre>{<br/> "name": "RHEL-8.*_HVM-*-x86_64-*-Hourly*-GP*,spel-bootstrap-rhel-8-*.x86_64-gp*",<br/> "owners": [<br/> "309956199498",<br/> "219670896067",<br/> "174003430611",<br/> "216406534498"<br/> ]<br/>}</pre> | no |
| <a name="input_aws_source_ami_filter_rhel9_hvm"></a> [aws\_source\_ami\_filter\_rhel9\_hvm](#input\_aws\_source\_ami\_filter\_rhel9\_hvm) | Object with source AMI filters for RHEL 9 HVM builds | <pre>object({<br/> name = string<br/> owners = list(string)<br/> })</pre> | <pre>{<br/> "name": "RHEL-9.*_HVM-*-x86_64-*-Hourly*-GP*,spel-bootstrap-rhel-9-*.x86_64-gp*",<br/> "owners": [<br/> "309956199498",<br/> "219670896067",<br/> "174003430611",<br/> "216406534498"<br/> ]<br/>}</pre> | no |
| <a name="input_aws_ssh_interface"></a> [aws\_ssh\_interface](#input\_aws\_ssh\_interface) | Specifies method used to select the value for the host in the SSH connection | `string` | `"public_dns"` | no |
| <a name="input_aws_subnet_id"></a> [aws\_subnet\_id](#input\_aws\_subnet\_id) | ID of the subnet where Packer will launch the EC2 instance. Required if using an non-default VPC | `string` | `null` | no |
| <a name="input_aws_temporary_security_group_source_cidrs"></a> [aws\_temporary\_security\_group\_source\_cidrs](#input\_aws\_temporary\_security\_group\_source\_cidrs) | List of IPv4 CIDR blocks to be authorized access to the instance | `list(string)` | <pre>[<br> "0.0.0.0/0"<br>]</pre> | no |
| <a name="input_aws_temporary_security_group_source_cidrs"></a> [aws\_temporary\_security\_group\_source\_cidrs](#input\_aws\_temporary\_security\_group\_source\_cidrs) | List of IPv4 CIDR blocks to be authorized access to the instance | `list(string)` | <pre>[<br/> "0.0.0.0/0"<br/>]</pre> | no |
| <a name="input_azure_build_resource_group_name"></a> [azure\_build\_resource\_group\_name](#input\_azure\_build\_resource\_group\_name) | Existing resource group in which the build will run | `string` | `null` | no |
| <a name="input_azure_client_id"></a> [azure\_client\_id](#input\_azure\_client\_id) | Application ID of the AAD Service Principal. Requires either client\_secret, client\_cert\_path or client\_jwt to be set as well | `string` | `null` | no |
| <a name="input_azure_client_secret"></a> [azure\_client\_secret](#input\_azure\_client\_secret) | Password/secret registered for the AAD Service Principal | `string` | `null` | no |
Expand Down

0 comments on commit 2c4a2b0

Please sign in to comment.