Introduction to the Ship lifecycle definition

This content is associated with a legacy version of the Replicated product. For the current Replicated product documentation, see

Ship Lifecycle

The lifecycle key is where you can define and customize the end-user experience for customers installing your application. A lifecycle has several step types:

  • "message" - print a message to the console. This can be used multiple times.
  • "config" - collect configuration from the end user based on the top-level config section
  • "render" - generate assets based on provided config values. This commonly is used once in an application.

In ship, a short assets section to pull and run a private docker container might look like

    - message:
        contents: |
          This installer will prepare assets so you can run CoolTool Enterprise.
    - config: {}
    - render: {}
    - message:
        contents: |
          Asset rendering complete! Copy the following files to your production server


          And then, on that server, run

             bash ./scripts/

          To start the app. Thanks for using CoolTool!