Convert a module

To convert an existing module to a PDK compatible module, run the pdk convert command.

  1. From the command line, change into the module's directory with cd <MODULE_NAME>
  2. Run the convert command: pdk convert

    Optionally, specify your own module template by adding the --template-url flag with the Git URL or local path to the template.

  3. If the existing module does not have a metadata.json file, respond to PDK metadata interview prompts to provide metadata information.
  4. Review the changes PDK is about to make and respond to the prompt to either continue or terminate the conversion. You can review a detailed change report in convert_report.txt in the module's root folder.

Result

If you confirm the conversion, the changes outlined in the report are applied to the module.