crossplane / crossplane/upjet

Usage of dots in metadata.name errors at Terraform level

Open
#143 3 comments 1 reaction 0 assignees View on GitHub
bug configuration v2
Dominant language
Go
Stars
481
Forks
131
Avg merge
2d 1h
Merged PRs (30d)
11

Description

### What happened?

We are getting errors from Terraform if the `metadata.name` contains dots, e.g. `example.com`, since we use the same [to name the terraform resource name](https://github.com/upbound/upjet/blob/2bd418a5521b5a4a575c0fae7185bd7f60a06560/pkg/terraform/files.go#L125) which does not accept dots in the name.

Note users would see this during runtime.

### How can we reproduce it?

Create an upjet generated MR with name dots inside.

### Possible Fixes
Not use `metadata.name` in cases where it would break. We need to be careful with the upgrade process.

Contributor guide

Open the contributing guide

Research direction

Start in pkg/terraform/files.go around the linked resource-name generation code and reproduce the issue with an Upjet-generated managed resource whose metadata.name contains dots. Trace how that name is used during runtime and review the upgrade process before choosing a compatible change. Done means dotted names no longer produce Terraform-level errors without breaking upgrades.

Written by the indexing model from the issue text.

Assessment

Tech stack
go, terraform
Domain
infrastructure, tooling
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.