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

[Feat] Add full terraform.tfvars variable list #10

Merged
merged 3 commits into from
Sep 26, 2023

Conversation

evberrypi
Copy link
Collaborator

Based on earlier discussion, users would find it helpful to have the full list of values prepopulated (and commented out) in the terraform.tfvars file

These values were autogenerated by running the terraform-docs tool

terraform-docs tfvars hcl 

@ikatz-nvidia
Copy link
Collaborator

Missing newlines at the ends of the files, otherwise LGTM

Copy link
Collaborator

@ikatz-nvidia ikatz-nvidia left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good. Am I wrong in observing that it appears to cause a breaking change and would require a major version bump when released?

@evberrypi evberrypi merged commit 77f3156 into NVIDIA:main Sep 26, 2023
@evberrypi evberrypi deleted the elacey/update-tfvars branch September 26, 2023 21:38
# Do not commit this file to Git with sensitive values

# cluster_name = ""
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To maintain consistency with other tfvars, can you add the cluster_name to be holoscan-cluster

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are auto generated. The values which appear here are the defaults from variables.tf. The tfvars make it simple for people to select the values themselves

@@ -2,8 +2,53 @@
# SPDX-License-Identifier: Apache-2.0

# Sample tfvars file. Uncomment out values to use
# Do not commit this file to Git with sensitive values

# cluster_name = "holoscan-cluster"
# region = "us-west-2"

# Optional: If deploying into an existing VPC, use the following variable
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably this comment should be moved just above existing_vpc_details variable.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed in #11

# additional_user_data = ""
# aws_profile = "development"
# cidr_block = "10.0.0.0/16"
# cluster_name = ""
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Already have cluster_name above

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Caught this after the merge. Fixed in #11

@@ -76,14 +76,14 @@ If it is needed to get the value of `log_analytics_workspace_primary_shared_key`
| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| <a name="input_admin_group_object_ids"></a> [admin\_group\_object\_ids](#input\_admin\_group\_object\_ids) | (Required) A list of Object IDs (GUIDs) of Azure Active Directory Groups which should have Owner Role on the Cluster. <br> This is not the email address of the group, the GUID can be found in the Azure panel by searching for the AD Group<br> NOTE: You will need Azure "Owner" role (not "Contributor") to attach an AD role to the Kubernetes cluster. | `list(any)` | n/a | yes |
| <a name="input_az_monitor-user-managed-id"></a> [az\_monitor-user-managed-id](#input\_az\_monitor-user-managed-id) | The user managed identity to *create* for use with the Azure monitor-- at this time this does not accept existing user or system managed identity | `string` | `"tf-holoscan-identity"` | no |
| <a name="input_az_monitor_user_managed_id"></a> [az\_monitor-user-managed-id](#input\_az\_monitor-user-managed-id) | The user managed identity to *create* for use with the Azure monitor-- at this time this does not accept existing user or system managed identity | `string` | `"tf-holoscan-identity"` | no |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Needs text update az\_monitor-user-managed-id

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for catching. Fixed in #11

@evberrypi
Copy link
Collaborator Author

This looks good. Am I wrong in observing that it appears to cause a breaking change and would require a major version bump when released?

There is no functional change here. The tfvars file is just a helper file. See Hashicorp's docs:

To set lots of variables, it is more convenient to specify their values in a variable definitions file

This file just has a commented out version of all possible variables

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants