FAQs "Operator Cockpit" - Developer Documentation
Skip to content

"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 or buildpacks 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 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

Note

Ensure the memory and disk_quota parameters are entered in proper integer values. For example, enter the memory and disk_quota values as show below: - memory: 1024M - disk_quota: 1024M

Note

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

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?
Yes, Auto-deployment supports both buildpacks or buildpack in application manifest file. However, since buildpack is deprecated, it is recommended to use buildpacks. The multi-buildpack will not work with system buildpack. Use the URLs instead. If there are multiple buildpacks in the manifest, ensure you have enough disk quota. if not,specify the disk quota in the manifest file. For more information, refer attributes.

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.

9.Why is it important to set the header size of the request to Industrial IoT APIs to 16kb as per the Gateway Restrictions while developing an application?
By default, the header size of any HTTP request is set to 8kb, if the technical token size increases beyond this limit the applications stops and the request to Industrial IoT API fails with "400 Bad Request response". To avoid this error, set the server_max_http_header_size: 16384 in the application configuration.

10.How to access the endpoints of provisioned API applications from the standard UI application using Advanced Token Exchange (ATE)?
To access the endpoints of provisioned API application using Advanced Token Exchange (ATE), refer to "Accessing Industrial IoT APIs from self-hosted Applications".

11.How to integrate the API application with a standard UI application hosted in the same tenant?
To integrate an API application with a standard UI application hosted in the same tenant, refer to "Integrating API application to the UI application".

12.How much time is required for the custom space created in Cloud Foundry to appear in the space location of the Information tab?
It takes 24 hours time for the custom space created in Cloud Foundry to appear in the space location of the Information tab

13.Does auto-deployment process create a new space with the same name as appname?
Yes. By default, auto deployment process creates a new space with the same name as the appname irrespective of selecting the space from the "Space Location" of the "Information" tab.


Last update: November 21, 2023