Skip to content

Latest commit

 

History

History
35 lines (29 loc) · 1.59 KB

README.md

File metadata and controls

35 lines (29 loc) · 1.59 KB
Raw

Using Upjet

Upjet consists of three main pieces:

  • Framework to build a code generator pipeline.
  • Generic reconciler implementation used by all generated CustomResourceDefinitions.
  • A scraper to extract documentation for all generated CustomResourceDefinitions.

The usual flow of development of a new provider is as following:

  1. Create a provider by following the guide here.
  2. Follow the guide here to add a CustomResourceDefinition for every resource in the given Terraform provider.

In most cases, the two guides above would be enough for you to get up and running with a provider.

The guides below are longer forms for when you get stuck and want a deeper understanding:

  • Description of all configuration knobs can be found here.
  • Detailed explanation of how to use Uptest to test your resources can be found here.
    • You can find a troubleshooting guide here that can be useful to debug a failed test.
  • References are inferred from the generated examples with a best effort manner. Details about the process can be found here.

Feel free to ask your questions by opening an issue, starting a discussion or shooting a message on Slack!