Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement multiline support for tfvars description #158

Merged
merged 3 commits into from
Sep 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions terraform.tfvars.example
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,9 @@ enable_ingress_nginx = false

enable_ivs = false

# Scans license server EC2 instance and EKS nodes for updates. Installs patches on license server automatically. EKS nodes need to be updated manually.
# Scans license server EC2 instance and EKS nodes for updates.
# Installs patches on license server automatically.
# EKS nodes need to be updated manually.
enable_patching = false

# The maximum number of nodes for gpu job execution
Expand Down Expand Up @@ -79,7 +81,9 @@ linuxExecutionNodeCountMin = 0
# The disk size in GiB of the nodes for the job execution
linuxExecutionNodeDiskSize = 200

# The machine size of the Linux nodes for the job execution, user must check the availability of the instance types for the region. The list is ordered by priority where the first instance type gets the highest priority. Instance types must fulfill the following requirements: 64 GB RAM, 16 vCPUs, at least 110 IPs, at least 2 availability zones.
# The machine size of the Linux nodes for the job execution, user must check the availability of the instance types for the region.
# The list is ordered by priority where the first instance type gets the highest priority.
# Instance types must fulfill the following requirements: 64 GB RAM, 16 vCPUs, at least 110 IPs, at least 2 availability zones.
linuxExecutionNodeSize = [
"m6a.4xlarge",
"m5a.4xlarge",
Expand All @@ -99,7 +103,9 @@ linuxNodeCountMin = 1
# The disk size in GiB of the nodes for the regular services
linuxNodeDiskSize = 200

# The machine size of the Linux nodes for the regular services, user must check the availability of the instance types for the region. The list is ordered by priority where the first instance type gets the highest priority. Instance types must fulfill the following requirements: 64 GB RAM, 16 vCPUs, at least 110 IPs, at least 2 availability zones.
# The machine size of the Linux nodes for the regular services, user must check the availability of the instance types for the region.
# The list is ordered by priority where the first instance type gets the highest priority.
# Instance types must fulfill the following requirements: 64 GB RAM, 16 vCPUs, at least 110 IPs, at least 2 availability zones.
linuxNodeSize = [
"m6a.4xlarge",
"m5a.4xlarge",
Expand Down
11 changes: 8 additions & 3 deletions tfvars.hcl.terraform-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,15 @@ content: |
{{ if .Module.Inputs -}}
{{- range $index, $element := .Module.Inputs }}
{{ if $element.Description -}}
# {{ tostring $element.Description }}
{{ if gt (len $element.Description) 120 }}
{{- range $value := (tostring $element.Description | split ". ") }}# {{ trimSuffix "." $value }}.
{{ end -}}
{{ else -}}
# {{ tostring $element.Description }}
{{ end -}}
{{ end -}}
{{ $element.Name }} = {{ $element.GetValue }}
{{ end -}}
{{- $element.Name }} = {{ $element.GetValue }}
{{ end }}
{{- end -}}
settings:
description: true