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

Configuration of the Example Generation Pipeline #6

Closed
ulucinar opened this issue Jun 6, 2022 · 0 comments · Fixed by #19
Closed

Configuration of the Example Generation Pipeline #6

ulucinar opened this issue Jun 6, 2022 · 0 comments · Fixed by #19
Assignees

Comments

@ulucinar
Copy link
Collaborator

ulucinar commented Jun 6, 2022

We need to be able to incorporate manual modifications to the extracted example manifests (and potentially to other metadata elements such as extracted field docs, etc.).

We already have a resource configuration framework in upjet, the config.Resource, which we would like to utilize also for metadata customizations.

For example, for manual customizations involving extracted example manifests, some anticipated use cases are:

  • Fixing syntax errors in the scraped examples from the Terraform registry
  • Adding/removing attributes, if desired, to/from the extracted example manifest
  • Adding/fixing/removing cross-resource references
  • Marking resources that require globally unique names, such as the Azure Key Vaults or AWS S3 buckets.
  • ...

We can use crossplane-runtime's fieldpath library and represent the example manifests with paved objects with field addressing semantics and field manipulation routines. This would also allow us to introduce repo-wide customizations, such as injecting a specific field (such as a region field) into all generated example manifests for a provider.

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 a pull request may close this issue.

1 participant