search

pivotal / docs-platform-automation

docs repo for the Platform Automation package
https://docs.pivotal.io/platform-automation/
Other
13 stars 12 forks source link

upgrade-opsman state.yml comments don't include usage of $timestamp for non-versioned s3 files #27

Closed bridgetarthur closed 4 years ago

bridgetarthur commented 4 years ago

URL or GitHub link to the page where you're having the issue https://docs.pivotal.io/platform-automation/v4.3/tasks.html#upgrade-opsman

Is your request for a change or addition to content related to a problem? If so, please describe. It wasn't clear how to utilize $timestamp for non-versioned s3 state.yml files, but we were able to find the solution looking at the comments in delete-vm

Describe the solution you'd like Add similar text from delete-vm to upgrade-opsman i.e

  # - Required
  # - Filepath of the state yaml file
  # - The path is relative to root of the `state` output
  # - if the filename includes "$timestamp",
  #   for example "state-$timestamp.yml",
  #   the final filename will include the current timestamp.
  #   - this is necessary if using an "S3 compatible" blobstore
  #     that doesn't support versioned blobs
  #   - timestamped filenames will need to be represented
  #     with a glob-style wildcard in tasks that use this state file
  #     (such as state-*.yml)
cf-gitbot commented 4 years ago

We have created an issue in Pivotal Tracker to manage this. Unfortunately, the Pivotal Tracker project is private so you may be unable to view the contents of the story.

The labels on this github issue will be updated when the story is started.

kcboyle commented 4 years ago

This should be updated both in staging and production docs. Thanks for bringing this to our attention!