Guidelines for zipping files

Rules to zip and upload binary files

During the uploading of an application, consider the following factors:

  • The zipping of the binary file should be in proper format.

  • The zipped folder should not be empty.

  • The "path" parameter in "manifest.yml" file should be as per the folder structure.

  • Except for the corresponding files of the application, there should not be any other additional/ duplicate files in the zipped folder.

Rules to create and upload a manifest file

For uploading a manifest file, the following factors should be considered:

  • The "name" parameter in "manifest.yml" should match the name entered in the "Components" section.

  • The "path" parameter in "manifest.yml" should point to the correct file/ files.

  • Do not use the following parameters in the manifest file as they are deprecated:

    • domain

    • domains

    • host

    • hosts

    • no-hostname

    • Use of 'buildpacks' attribute in manifest is not fully supported. Hence use of 'buildpack' is favored. The feature will be updated in future. Please see Cloud Foundry Dev Guide for manifest deprecations.

  • It is recommended to use random-route: true to avoid path conflicts.

  • If a user wants to specify routes for an application, the user has to use routes attribute.

NOTE

If "buildpack" and "memory" are not specified in the manifest file, auto-deployment option is disabled in Operator Cockpit.

"Buildpacks" works for manual deployments only because CF Java library still does not support "buildpacks" for auto deployment. "Buildpack" works for both auto & manual deployment.

Example scenario to upload zip and manifest files

Let us consider a zipped file "appbinary.zip".

To upload a zipped file, it should have the following zipping structure:

119376362123.png

The manifest file has the following structure with "buildpack":

123058524427.png

Manifest with random-route: true and path corresponding to zipping structure

Manifest with random-route: false and with specified routes and path corresponding to zipping structure