"Operator Cockpit" FAQs

Auto-deployment

  1. What are the consequences if there exists an unwanted "manifest.yml" file within the appbinary?

    For example, if manifest.yml file exists inside application.war/WEB-INF in appbinary, then the application will be automatically removed from the operator's CF space and cannot be used anymore.

  2. Can the "routes" attribute be used in conjuction with "manifest" attributes?

    No, "routes" attribute should not be used in conjunction with host, hosts, domain, domains and no-hostname. If used in conjuction, an error will result.

  3. Can I push an application without specifying any route related CLI options or app "manifest" flags?

    No. It is always recommended to push an application by specifying route related options. If the route is not specified, then the CF CLI attempts to generate a route based on the app name which might cause collisions. You can also use random-route attribute to generate a unique route name and avoid collisions.

  4. What are the pre-conditions to have "Auto deployment" as an available option for deployment?

    For auto deployment to be enabled, the following conditions must be satisfied:

    • Make sure that your application contains the manifest file.

    • Validation of the following parameters in the manifest file:

    Parameters in manifest.yml

    Auto deployment option

    buildpack is not available

    Disabled

    path is not available

    Disabled

    memory is not available

    Disabled

    domain is available

    Disabled (since domain parameter is deprecated)

    domains is available

    Disabled (since domains parameter is deprecated)

    host is available

    Disabled (since host parameter is deprecated)

    hosts is available

    Disabled (since hosts parameter is deprecated)

    random-route is not available or set to false

    Disabled

    Procfile in the given path is available for the applications other than binary_buildpack

    Disabled

    • For more information on the development files that disable auto deployment, refer Preparation Checklist.

  5. Can we use fixed "route" in app manifest file?

    It is not recommended to use fixed "route" since it might cause route collisions following which auto-deployment will fail.

    In such cases, you need to use manual deployment with an unoccupied route or change the route configuration as "--random-route".

  6. Can I use any random format for manifest?

    No. Operator Cockpit does not support manifest of random formats. For correct format of manifest, see the below table:

    Parameters checklist

    Check type

    Checked values

    Implication (when failed)

    name

    DataType/Value

    String/Non-Empty

    Upload Failure

    memory

    DataType/Value

    String/Non-Empty

    Disable Auto-Deployment

    buildpack*

    (If buildpacks parameter is used while uploading from Developer Cockpit, then key will be removed from the manifest file after it is handed over to Operator Cockpit.)

    DataType/Value

    String/Non-Empty

    Disable Auto-Deployment

    path

    DataType/Value

    String/Non-Empty

    Disable Auto-Deployment

    domain

    DataType

    String

    Upload Failure

    host

    DataType

    String

    Upload Failure

    env

    Value

    key-value pair(key being String, and value being Object)

    Upload Failure

    services

    DataType

    List<String>

    Upload Failure

  7. Does auto-deployment in Operator Cockpit support buildpacks parameter in the manifest file of an application to provide information regarding the framework and runtime support for an application?

    No. Auto-deployment does not support buildpacks in application manifest file. However, the application can be deployed by following the steps below:

    • Download the application from Operator Cockpit

    • Add "buildpacks" parameter in the manifest file

    • Use manual deployment (Deployment via CF CLI) option in Operator Cockpit to deploy the application

  8. Can the path attribute in manifest start with slash (/)?

    No. If the path attribute in manifest starts with slash(/), then auto-deployment of an application will not work as desired. For auto-deployment to be successful, remove the slash(/) from path attribute in manifest and restart the process.