Generators for Cray Projects

Requirements

Before you can run any generator, you'll need to make sure the following requirements are met on your local machine:

• Install craypc and it's requirements

Running Generators

Once craypc is installed, you can get further help:

# Things move fast.  Help is always more up to date than the readme
# Usage and help for the generators cli tool
craypc generators help

# Did you try help first?
craypc generators generate cray-service --sections=kubernetes # answer some questions and get a pull request with a new helm chart
craypc generators generate cray-service --sections=service # answer some questions and get a pull request with a new api codegen-ed just for you
craypc generators generate cray-service --sections=cli # answer some questions and get a pull request for cli integration

# learn more about craypc itself, see it's usage and help
craypc --help

The following generators are available

• cray-service: if you're starting a new project for an internal Cray service/API, or if you need to update an existing service with Cray standard resources
• cray-generator: A generator for creating a new Cray generator, in an oh-so meta way

You can run these generators by:

craypc generators generate [generator name]

The above will kick off a process that will ask you some questions to generate what you need in your given project. For help on the generate command and available generator names:

craypc generators generate help

Developing

Working with the generators here

See each of the individual generator directories for more info on working with them, developing them:

• generator-cray-generator: for creating new generators here
• generator-cray-service: generator for cray services, swagger codegen, helm charts, cli integration, etc.

Starting New Generators

You'll want a local clone for this, then run from within the clone:

craypc local generate cray-generator

Run the above, it'll ask you some questions, and then create a new named generator directory here. You can then begin development on the generator itself locally. Refer to the README in the newly-created generator for more info on developing it out.

Releasing for craypc

Make necessary changes, increment version in:

1. relevant package.json files, depending on what changed
2. .craypc/config.yaml

# this method will go away when we roll things into the DST pipeline appropriately
craypc local publish