gcphcl / deploymentmanager-autogen

Deployment Manager Autogen

Deployment Manager Autogen is a Java-based tool for generating fully functional Deployment Manager templates from simplified YAML, JSON or Prototext configuration files.

It currently supports single and multi VM configurations.

Running Autogen through CLI

With AutogenCli, you will be able to generate your solution package through command line by providing your configuration in a JSON, YAML or Prototext file.

Your configuration file should follow the schema described in the DeploymentPackageInput proto, if you want to generate deployment package for a single solution, or BatchInput proto for multiple solutions. Both specs can be found in autogen.proto.

AutogenCli parameters

• --single_input

  Option to indicate that Autogen will be run on a configuration that contains a DeploymentPackageInput spec. If an argument is specified, AutogenCli will interpret it as a path to a file to read the spec from. If empty, AutogenCli will read from stdin. (either --single_input or --batch_input needs to be provided).

• --batch_input

  Option to indicate that Autogen will be run on a configuration that contains a BatchInput spec. If an argument is specified, AutogenCli will interpret it as a path to a file to read the spec from. If empty, AutogenCli will read from stdin. (either --single_input or --batch_input needs to be provided).

• --input_type (optional, defaults to PROTOTEXT)

  Indicates the format of the spec that AutogenCli will read. Available options are: YAML, JSON, PROTOTEXT or WIRE (binary prototext).

• --output_type (optional, defaults to PROTOTEXT)

  Indicates the format of the spec that AutogenCli will write. Available options are: YAML, JSON, PROTOTEXT, WIRE or PACKAGE.

• --output (optional)

  If --output_type is PACKAGE, the argument of this option will be interpreted as a destination folder for the deployment files to be written to. If left empty or not provided, it will use the current directory that the binary is being run.
  For all other --output_type options, the argument of this option will be interpreted as a path to file to write the output to. If empty or not provided, it will defaults to stdout.

• --exclude_shared_support_files (optional)

  If provided, Autogen will NOT include the shared support files used for deployment in this solution (look here for those files). By default Autogen always include those files (recommended).

You can also see those options by providing --help as the argument for AutogenCli

Example configurations

We have provided a full featured example in the example-config folder.

Please refer to the comments inside the config example and the proto files (autogen.proto, deployment_package_autogen_spec.proto and marketing_info.proto) for more information about the fields and which of those are required and optional.

You can then change the fields to reflect the configuration of your solution and run Autogen.

Example commands

It's easiest to use our released docker images. If you want to build and run the tool from source, see the Development section below.

Make sure docker has been installed.

Let's set up an alias to make your commands clean:¹

alias autogen='docker run \
  --rm \
  --workdir /mounted \
  --mount type=bind,source="$(pwd)",target=/mounted \
  --user $(id -u):$(id -g) \
  gcr.io/cloud-marketplace-tools/dm/autogen'

autogen --help

The command below takes the spec in example-config/solution.yaml and output all the files into solution_folder. You can then compress the solution_folder folder and use partner portal to upload your deployment package: https://console.cloud.google.com/partner

mkdir solution_folder

autogen \
  --input_type YAML \
  --single_input example-config/solution.yaml \
  --output_type PACKAGE \
  --output solution_folder

NOTE: Only files in the current working folder can be seen and manipulated by the tool. The input and output file parameters must be passed using relative paths.

Other sample configurations are also available in testdata folder.

The command below runs a sample test proto definition transformation with printing the deployment package in JSON format, run the following command:

autogen \
  --input_type PROTOTEXT \
  --single_input javatests/com/google/cloud/deploymentmanager/autogen/testdata/singlevm/full_features/input.prototext \
  --output_type JSON

¹A few notes about the alias:

• Since we're running the tool from within a docker container, we need to make the local filesystem available to the container. We do this by --mounting the current working directory. Within the container runtime, the content is available at /mounted.
• We additionally set --workdir to /mounted for the running container, so the file parameters like --single_input can use relative paths.
• We add --user to instruct docker to run as the current user instead of root.

Development

Prerequisites

• bazel: Install here.
• Java: Check bazel docs on how to install and setup a Java environment.

Build

To build all the artifacts, run the following bazel command:

bazel build java/com/google/cloud/deploymentmanager/autogen/...:all

If you want, you can also build AutogenCli_deploy.jar target, to run the jar as a standalone application

bazel build java/com/google/cloud/deploymentmanager/autogen/cli:AutogenCli_deploy.jar

Run the CLI tool

An example:

bazel-bin/java/com/google/cloud/deploymentmanager/autogen/cli/AutogenCli \
  --input_type YAML \
  --single_input example-config/solution.yaml \
  --output_type PACKAGE \
  --output solution_folder

Run tests

bazel test javatests/com/google/cloud/deploymentmanager/autogen:all

Troubleshooting

If you see errors when trying to build Autogen using bazel, try to run the following command and then try again:

bazel clean --expunge