The application manifest file

Edit online

The application manifest file is a local YAML file that lists the artifacts of an application and contains information on where they are stored.

To make the most of the following explanations, you must be familiar with The Wazi Deploy workflow.

What is the application manifest file

In a static deployment, where Wazi Deploy deploys the application package that you provide as input, Wazi Deploy uses the manifest to know the list of the artifacts that your application package contains.

Note: In the case of legacy applications, the application manifest might contain an incomplete list of artifacts. In this case, the application manifest is enriched every time that a new artifact is added to the build process.

The application manifest file is generated by The Wazi Deploy packager command and used as input to The Wazi Deploy generation command.

Structure and parameters

This file must not contain any information about the target environment. Its model is constrained and must follow a predefined structure.

The following code shows the beginning of a sample application manifest file. 
apiVersion: wazideploy.ibm.com/v1
kind: ManifestState
metadata:
  name: GenAppCICS
  description: GenAppCICS
  version: 1.0.359
  annotations:
    creationTimestamp: 20220809.092936.548
    scm:
      type: git
      uri: git@github.com:myuser/cics-genapp.git
      branch: HEAD
      shortCommit: 02ad1c4c
    package:
      name: cics-genapp-build-main
      description:
      properties:
      - key: repoPath
        value: cics-genapp-build/cics-genapp-build-main
      uri: https://example.artifactory.com/ui/builds/cics-genapp-build-main/7
      type: ARTIFACTORY
artifacts:
- name: LGUCDB01
  description: LGUCDB01.CICSLOAD
  properties:
  - key: path
    value: CICSLOAD/LGUCDB01.CICSLOAD
  type: CICSLOAD
  hash: 0d5c0cfe38d672389b859925fededc56b4a28a41a3183103519982b324cb4bd3
- name: LGUPDB01
  description: LGUPDB01.DBRM
  properties:
  - key: path
    value: DBRM/LGUPDB01.DBRM
  type: DBRM
  hash: 1376845d53f8f5edd8bf7e2f5e46028da4ec14f7912df68d2fc56620f5d11b6d
deleted_artifacts:
- name: LGACDB02
  description: LGACDB02.CICSLOAD
  properties:
  - key: path
    value: NAZARE.WDEPLOY.DBBBUILD.GENAPP.LOAD/LGACDB02.CICSLOAD
  type: CICSLOAD

An application manifest file is constituted of the following parameters:

metadata
The metadata of the application manifest that was generated by the Wazi Deploy packager.
  • name

    The name of the application to be deployed.

  • description

    The optional description of the application to be deployed.

  • version

    The version of the application to be deployed.

  • annotations
    Any valid YAML contents. The annotations parameter typically contains the following fields:
    • The creationTimestamp of the manifest.
    • The package level with the name and location of the application package in the source control management system.
artifacts
Information on each artifact in the application package file.
  • name

    Name of the artifact.

  • description

    Name of the artifact, followed by its type (for example LGUCDB01.CICSLOAD).

  • properties

    The key and associated value that are listed for each artifact.

    In a static deployment, the key is the path to the artifact in the package file.

  • type

    The artifact type that is indicated in the deployment method.

  • hash

    When the manifest is produced by The Wazi Deploy packager command, the hash is the sha256 value of the source file.

deleted_artifacts
The artifacts that are to be deleted.
  • name

    Name of the artifact.

  • description

    The optional description.

  • properties

    The key and associated value that are listed for each artifact.

    In a static deployment, the key is the path to the artifact in the package file.

  • type

    The artifact type that is indicated in the deployment method.