Porter Manifest File Format 1.1.0

schemaType: Bundle
schemaVersion: 1.1.0
name: myapp
version: 1.0.0
description: Install my great application
registry: localhost:5000
reference: localhost:5000/myapp:v1.0.0
dockerfile: template.Dockerfile

maintainers:
  - name: Qi Lu
  - email: sal@example.com
  - name: Frank
    url: https://example.com/frank

custom:
  app:
    version: 1.2.3
    commit: abc123

required:
  - docker:
      privileged: true

mixins:
  - exec
  - helm3:
      clientVersion: 3.1.2

credentials:
  - name: kubeconfig
    description: A kubeconfig with cluster admin role
    path: /root/.kube/config
  - name: token
    env: GITHUB_TOKEN
    applyTo:
      - release

parameters:
  - name: log-level
    description: Log level for MyApp
    type: integer
    env: MYAPP_LOG_LEVEL
    applyTo:
      - install
      - upgrade
  - name: connstr
    description: MyApp database connection string
    type: string
    env: MYAPP_CONNECTION_STRING
    sensitive: true
    source:
      dependency: mysql
      output: admin-connstr
    applyTo:
      - upgrade
      - status
  - name: release-name
    type: string
    env: RELEASE
    default: myapp

state:
  - name: tfstate
    description: Store terraform state with the bundle instead of a remote backend
    path: terraform/terraform.tfstate

dependencies:
  provides:
    interface:
      id: "https://example.com/interfaces/#something"
  requires:
    - name: mysql
      bundle:
        reference: getporter/mysql:v0.1.1
        interface:
          id: "https://getporter.org/interfaces/#mysql"
      sharing:
        mode: group
        group:
          name: myapp
      parameters:
        database: myapp
        logLevel: ${bundle.parameters.log-level}
      credentials:
        kubeconfig: ${bundle.credentials.kubeconfig}
      outputs:
        admin-connstr: Server=${outputs.server};Database={outputs.database};Uid=admin;Pwd=${outputs.password};

outputs:
  - name: app-token
    description: Access token for MyApp
    type: file
    path: /cnab/app/myapp_token
    sensitive: true
    applyTo:
      - install
  - name: ip-address
    type: string

images:
  myapp:
    repository: example/myapp
    digest: sha256:568461508c8d220742add8abd226b33534d4269868df4b3178fae1cba3818a6e

install:
  - helm3:
      description: "Install MyApp"
      name: ${ bundle.parameters.release }
      chart: ./charts/myapp
      replace: true
      set:
        image.repository: ${ bundle.images.myapp.repository }
        image.digest: ${ bundle.images.myapp.digest }

upgrade:
  - helm3:
      name: ${ bundle.parameters.release }
      chart: ./charts/myapp
      set:
        image.repository: ${ bundle.images.myapp.repository }
        image.digest: ${ bundle.images.myapp.digest }

uninstall:
  - helm3:
      purge: true
      releases:
        - ${ bundle.parameters.release }

poke:
  - exec:
      command: ./poke-myapp.sh

customActions:
  status:
    description: See what's up in there
    modifies: false
    stateless: true

status:
  - exec:
      command: ./status.sh