Skip to content

Commit

Permalink
Mention bootstrapping a new provider from scratch in
Browse files Browse the repository at this point in the history
the Terrajet-to-Upjet migration guide

Signed-off-by: Alper Rifat Ulucinar <ulucinar@users.noreply.github.com>
  • Loading branch information
ulucinar committed Nov 25, 2022
1 parent 42be93d commit da395ec
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion docs/migrating-from-terrajet-to-upjet.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,17 @@ As [Terrajet] is being [deprecated][terrrajet-deprecation] in favor of [Upjet],
new Crossplane providers are expected to be generated using Upjet's [provider
template repository](/~https://github.com/upbound/upjet-provider-template), and
this guide outlines the steps needed to convert an existing Terrajet-based
Crossplane provider to an Upjet-based one.
Crossplane provider to an Upjet-based one. While this guide describes the
steps needed to update the `github.com/crossplane/terrajet` Go module
dependency with the `github.com/upbound/upjet` module, especially if you
have not customized your provider's CI pipelines and want to utilize the
new features offered by Upjet (such as documentation/example manifest
generation), you may also prefer to [bootstrap a new provider] from the
[Upjet template repository] and copy your existing resource configurations
under the `config` folder of your existing provider to the new provider.
The steps involved are similar in both approaches but this guide provides
more flexibility as we have indicated certain steps as optional to the
migration process.

### Overview of Terrajet-Upjet Migration Steps

Expand Down Expand Up @@ -187,5 +197,7 @@ the template repo's [Makefile](/~https://github.com/upbound/upjet-provider-templat
[resource configuration API]:
/~https://github.com/upbound/upjet/blob/7e84c638a8bc5c93c6da3cf9420f961f165dd05d/pkg/config/resource.go#L258
[reference configurations]: /~https://github.com/upbound/upjet/blob/c82119f5ef342f752406a0ed38264940b02e795f/pkg/config/resource.go#L293
[Upjet template repository]: /~https://github.com/upbound/upjet-provider-template
[Makefile]: /~https://github.com/upbound/upjet-provider-template/blob/d34119409586f6205ec8ed4b9b2c2481c74bf07e/Makefile#L41
[Terraform registry]: https://registry.terraform.io/
[bootstrap a new provider]: /~https://github.com/upbound/upjet/blob/main/docs/generating-a-provider.md

0 comments on commit da395ec

Please sign in to comment.