1.1.0

Features

• (EXPERIMENTAL) pre-deploy-check has been added as a new command. This command can be run at any time. It will scan the director and any staged tiles in an Ops Manager environment for invalid or missing properties. It displays these errors in a list format for the user to manually (or automatedly) update the configuration. This command will also return an exit status 1; this command can be a gatekeeper in CI before running an apply-changes
• download-product will now include the product-version in download-file.json
  Thanks to @vchrisb for the PR on issue #360

Bug Fixes

• Extra values passed in the env file will now fail if they are not recognized properties.
  This closes issue #258
• om will now allow non-string entities to be passed as strings to Ops Manager.
  This closes issue #352
• the file outputted by download-product will now use the product-name as defined in the downloaded-product, not from the Pivnet slug.
  This fixes a mismatch between the two as documented in issue #351
• bosh-env will now set BOSH_ALL_PROXY without a trailing slash if one is provided.
  This closes issue #350

1.0.0

Breaking Changes

• om will now follow conventional Semantic Versioning, with breaking changes in major bumps, non-breaking changes for minor bumps, and bug fixes for patches.
• delete-installation now has a force flag. The flag is required to run this command quietly, as it was working before. The reason behind this is it was easy to delete your installation without any confirmation.
• staged-director-config no longer supports --include-credentials this functionality has been replaced by --no-redact. This can be paired with --include-placeholders to return a interpolate-able config with all the available secrets from a running OpsMan. This closes issue #356. The OpsMan API changed so that IAAS Configurations were redacted at the API level.

Features

• new command diagnostic-report returns the full OpsMan diagnostic report which holds general information about the targeted OpsMan's state. Documentation on the report's payload can be found here.

• om interpolate now can take input from stdin. This can be used in conjunction with the new diagnostic-report command to extract a specific section or value from the report, simply by using the pipe operator. For example,

  om -e env.yml diagnostic-report | om interpolate --path /versions

  This will return the versions block of the json payload:

  installation_schema_version: "2.6"
  javascript_migrations_version: v1
  metadata_version: "2.6"
  release_version: 2.6.0-build.77

• staged-director-config now checks ints and bools when filtering secrets

• configure-director and staged-director now support iaas-configurations. This allows OpsManager 2.2+ to have multiple IAASes configured. Please see the API documentation for your version of OpsMan for what IAASes are supported.

  If you are using iaas_configuration in your properties-configuration and use iaas-configurations
  you'll receive an error message that only one method of configuration can be used.

0.57.0

Features

• new command assign-multi-stemcell supports the OpsMan 2.6+.
  This allows multiple stemcells to be assgined to a single product.
  For example, for product foo,
  you could assign Ubuntu Trusty 3586.96 and Windows 2019 2019.2,
  using the command, om assign-multi-stemcell --product foo --stemcell ubuntu-trusty:3586.96 --stemcell windows2019:2019.2.
• upload-stemcell will not upload the same stemcell (unless using --force) for OpsMan 2.6+.
  The API has changed that list the stemcells associated with a product.
  This command is still backwards compatible with OpsMan 2.1+, just has logic specific for 2.6+.

NOTES

• WasabiAiR/stow#197 has been merged! This should make om go get-able again.

0.56.0

Breaking Changes

• the upload-product flag --sha256 has been changed to --shasum. upload-stemcell used the --shasum flag, and this change adds parity between the two. Using --shasum instead of --sha256 also future-proofs the flag when sha256 is no longer the de facto way of defining shasums.

Features

• download-product now supports skipping ssl validation when specifying --pivnet-disable-ssl
• download-product ensures sha sum checking when downloading the file from Pivotal Network
• upload-stemcell now supports a --config(-c) flag to define all command line arguments in a config file. This gives upload-stemcell feature parity with upload-product
• Improved info messaging for download-product to explicitly state whether downloading from pivnet or S3

0.55.0

Features

• configure-director now has the option to ignore-verifier-warnings.
  (PR #338 Thanks @Logiraptor!)
  This is an advanced feature
  that should only be used if the user knows how to disable verifiers in OpsManager.
  This flag will only disable verifiers for configure-director,
  and will not disable the warnings for apply-changes.
• There's now a shell-completion script;
  see the readme for details.
• We have totally replaced the code and behavior
  of the experimental config-template command.
  It now contains the bones of the tile-config-generator.
  We expect to further refine
  (and make breaking changes to) this command in future releases.

0.54.0

Breaking Changes

• download-product's prefix format and behavior has changed.
  • the prefix format is now [example-product,1.2.3]original-filename.pivotal.
  • the prefix is added to all product files if s3-bucket is set in the config when downloading from Pivnet.

Features

• download-product now supports downloading stemcells from S3, too.
• download-product allows use of an instance iam account when s3-auth-method: iam is set.
• apply-changes now has the ability to define errands via a config file when running (as a one-off errand run).
  The apply-changes readme details how this
  config file should look.
• pending-changes now supports a --check flag, that will return an exit code 0(pass) or 1(fail) when running the command,
  to allow you to fail in CI if there are pending changes in the deployment.
• download-product will now create a config file (assign-stemcell.yml) that can be fed into assign-stemcell. It will have the appropriate
  format with the information it received from download-product

Bug Fixes

• when trying to delete a product on Ops Manager during a selective deploy (apply-changes --product-name tile),
  OpsManager would fail to apply-changes due to a change to the version string for 2.5 (would include the build
  number). A change was made to the info service to accept the new semver formatting as well as the old
  versioning.
• upload-product (among other things) is no longer sensitive to subdirectories in tile metadata directories
• to support 2.5, @jplebre and @edwardecook submitted a PR to support new semver versioning for
  OpsManager in addition to supporting the current versioning format.

WARNING

To anyone who is having go install fail, it will fail until WasabiAiR/stow#199 is merged.

Here is the error you are probably seeing.

$ go install
# github.com/pivotal-cf/om/commands
commands/s3_client.go:62:3: undefined: s3.ConfigV2Signing

to work around, you can include om in your project without using go get or go install. you will need to add the following to your go.mod:

replace github.com/graymeta/stow => github.com/jtarchie/stow v0.0.0-20190209005554-0bff39424d5b

0.53.0

Bug Fixes

• download-product would panic if the product was already downloaded and you asked for a stemcell. This has been fixed to behave appropriately

WARNING

The behavior of download-product in this release is not final. Please hold off on using this feature until a release without this warning.

0.52.0

Breaking changes

• download-product will now enforce a prefix of {product-slug}-{semver-version} when downloading from pivnet. The original filename is preserved after the prefix. If the original filename already matches the intended format, there will be no change. Any regexes that strictly enforce the original filename at the beginning of the regex will be broken. Please update accordingly. This change was done in order to encourage tile teams to change their file names to be more consistent. Ops Manager itself has already agreed to implement this change in newer versions.

Features

• add support for the selected_option field when calling staged-config to have better support for selectors.
  • this support also extends to configure-product, which will accept both selected_option and option_value as
    the machine readable value.
• download-product now has support for downloading from an external s3 compatible blobstore using the --blobstore s3
  flag.
• staged-director-config now supports a no-redact flag that will return all of the credentials from an Ops Manager
  director, if the user has proper permissions to do so. It is recommended to use the admin user.

WARNING

The behavior of download-product in this release is not final. Please hold off on using this feature until a release without this warning.

0.51.0

Features

• import-installation provides validation on the installation file to ensure
  • it exists
  • it is a valid zip file
  • it contains the installation.yml artifact indicative of an exported installation

Bug Fixes

• Fixed typo in configure-director vmextensions

0.50.0

Breaking changes

configure-director and staged-director-config now include a properties-configuration.

The following keys have recently been removed from the top level configuration: director-configuration, iaas-configuration, security-configuration, syslog-configuration.

To fix this error, move the above keys under 'properties-configuration' and change their dashes to underscores.

The old configuration file would contain the keys at the top level.

director-configuration: {}
iaas-configuration: {}
network-assignment: {}
networks-configuration: {}
resource-configuration: {}
security-configuration: {}
syslog-configuration: {}
vmextensions-configuration: []

They'll need to be moved to the new 'properties-configuration', with their dashes turn to underscore.
For example, 'director-configuration' becomes 'director_configuration'.
The new configration file will look like.

az-configuration: {}
network-assignment: {}
networks-configuration: {}
properties-configuration:
  director_configuration: {}
  security_configuration: {}
  syslog_configuration: {}
  iaas_configuration: {}
  dns_configuration: {}
resource-configuration: {}
vmextensions-configuration: []

Features

• The package manager has been migrated from dep to go mod. It now requires golang 1.11.4+. For information on go modules usage, see the golang wiki.

Bug Fixes

• import-installation will now retry 3 times (it uses the polling interval configuration) if it suspects that nginx has not come up yet. This fixes an issue with opsman if you tried to import an installation with a custom SSL Cert for opsman.
• When using configure-product on opsman 2.1, it would fail because the completeness check does not work. To disable add the field validate-config-complete: false to your config file.
• fix the nil pointer dereference issue in staged-products when om cannot reach OpsManager