api-layer icon indicating copy to clipboard operation
api-layer copied to clipboard

Wizard for static onboarding doesn't work

Open taban03 opened this issue 2 years ago • 1 comments

Describe the bug EDIT: After further research, there seems to be different issues when trying to onboard a service using the Wizard UI:

  1. The catalogUiTileId is missing from the final configuration. Specifically, the issue occurs when the user chooses an existing tile under Choose existing catalog tile or create a new one: dropdown (Basic section of the static onboarding method in Wizard). The mandatory catalogUiTileId property is removed from the final configuration. Instead, if the user selects the option Custom it will correctly add the property. Both catalogUiTileId and catalogUiTiles are mandatory. The final yaml should look like this:
services:
  - serviceId: 
    title: 
    description: 
    catalogUiTileId: EXISTING-TILE
    instanceBaseUrls:
      - 
    homePageRelativeUrl: /
    statusPageRelativeUrl: 
    healthCheckRelativeUrl:
    routes:
      - gatewayUrl: 
        serviceRelativeUrl: 
    authentication:
      scheme:
    apiInfo:
      - apiId: 
        version: 
        gatewayUrl:
        swaggerUrl: 
catalogUiTiles:
  EXISTING-TILE:
    title: 
    description: 
  1. The service id field in the Wizard states Field must be lowercase; Max length is 40 characters. However, while this works fine on local API ML instance, it seems to not work properly on z/OS. I.e. myservice12-dev will not cause issues, but myservice1234-dev seems to prevent the onboarding on z/OS - maybe due to some encoding problem happening when trying to create the file and place it in the api-def directory. As a result, the service configuration file is not even created.

  2. On safari the Wizard UI is broken. The form is not displayed.

  3. No proper logs are displayed in case some issue occurs when the static definition creation fails. A good idea would be to maybe also display a more meaningful message in the UI reporting the problem.

Steps to Reproduce

  1. Log into the API Catalog and select Static Onboarding method option from the Wizard dropdown menu
  2. Fulfil the Wizard form following one of the cases described above
  3. Click on Submit and expect either the error message saying that the onboarding was unsuccessful or the configuration with missing catalogUiTileId

Expected behavior It is possible to onboard a service using the Wizard UI, even on Safari.

https://github.com/zowe/api-layer/wiki/Issue-management

taban03 avatar Nov 08 '22 12:11 taban03

Whether the issue is permissions or something else, it would also be helpful if the error message has some details, so I have some idea of what went wrong.

mheuzey avatar Nov 08 '22 12:11 mheuzey