A power tool for Red Hat Software Certification Partners.
The productctl
utility allows Red Hat Software Certification Partners to
easily iterate on the definition of their product listings in a familiar way.
This tooling is intended for Red Hat Software Certification Partners who are working through the Software Certification Process for Containers, Helm Charts, and Operators. It will allow you to populate much of the metadata about your Certification Components and Product Listings from your workstation.
Caution
- This utility is in very early development.
- Users will assume all risk of using this tooling, including overwriting product metadata.
- This tool is not supported by Red Hat Support.
- Every API used here is subject to change.
Manage your Product Listing
Usage:
productctl product [command]
Available Commands:
apply Apply changes to Partner product listings from the input file.
cleanup Detaches and archives components. Deletes the product listing. This is destructive. Use with caution.
create Start building a new product listing declaration on your filesystem
fetch Get a pre-existing product listing
jsonschema Generate resource jsonschema for LSPs that support it.
sanitize Cleans declaration for re-use and emits to stdout
Flags:
--custom-endpoint string Define a custom API endpoint. Supersedes predefined environment values like "prod" if set
--env string The catalog API environment to use. Choose from stage, prod (default "prod")
-h, --help help for product
Global Flags:
--log-level string The verbosity of the tool itself. Ex. error, warn, info, debug (default "info")
Use "productctl product [command] --help" for more information about a command.
- (Prereq) Make sure your environment has the necessary variables
export CONNECT_API_TOKEN=yourtoken
export CONNECT_ORG_ID=000000000
- Scaffold your new Product Listing (or fetch an existing one)
productctl product create [--from-discovery-json /path/to/discovery.json] my.product.yaml
Or fetch an existing listing:
productctl product fetch 000111222333 > my.product.yaml
-
Make alterations to your Product Listing, add/remove components, etc.
-
Apply your Product Listing
productctl product apply my.product.yaml
- Repeat until all metadata is configured to your liking.
See our Getting Started guide.