openfabr / cdf Goto Github PK

Is your feature request related to a problem? Please describe.
The current API for custom modules is not compatible with Pulumi because of differences between CDK and Pulumi. Unlike CDK, Pulumi doesn't support changing or adding the config of ComponentResources via properties. There's method that can be called on instances either. AFAIK the only way is through the args param through the constructor.

Describe the solution you'd like
TBD how to change the API. But the outcome is to support custom modules for Pulumi.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
The sample Pulumi project (currently on a branch) has the outline of a custom module. So a good starting point to understand the situation.

The CDF CLI isn't discoverable easily. It's part of the CDF mono repo.

There's basic docs in the readme. Should add as an item in the left nav of the main docs site.

• add copy of the readme content as a reference.
• add more context around when/why use the schema gen functionality.

cdf-cli packages init <name> --language=<lang> --runtime=<awscdk | cdktf > --cicd=<github>

Generates scaffolding for a package from a template. Initially we'll only support TypeScript. Includes custom module template files and build and deploy config (only actions supported initially). Template TBD (probably base off the sample package with some adjustments).

note: cdf-cli is the name of the executable.

cdf-cli projects init <name> --package-manifest=<manifest file path>

Generates a AWS CDK or CDK TF project scaffolding based on a package by providing a package manifest. Sample config is also generated based on the package schema.

note: cdf-cli is the name of the executable.