Creating Apps - Teradata AppCenter

Teradata® AppCenter User Guide

Product
Teradata AppCenter
Release Number
2.0
Published
September 2020
Language
English (United States)
Last Update
2020-09-28
dita:mapPath
zzv1586527506119.ditamap
dita:ditavalPath
ft:empty
dita:id
B035-1111
Product Category
Analytical Ecosystem

"" User, Administrator

  1. Make sure the root user has added a registry for docker images that you can specify in the App Container settings.
  2. Select "" > Develop > Create.
  3. Enter a name up to 64 characters for this app, select Application, then select an app type.
    Once you save the app name and type, you cannot change app type.
  4. On Setup Guide, select AppContainer, then complete the registry, image, user credentials, and path with the following considerations:
    Option Considerations
    Image
    • For apps that run until stopped, make sure the Docker image you specify has at least one port exposed. The exposed port enables users to access the app from a browser. If the image includes more than one exposed port, you can select another port from the list after you save the container.
    • If the image includes environment variables, AppCenter automatically adds them to Settings when you save the container information.
    • AppCenter supports security scan for Docker images up to 500 MB. If you need AppCenter to scan Docker images greater than 500 MB, contact Teradata Professional Services for assistance increasing the memory/CPU limit on Anchore Engine services.
    For security protection, AppCenter scans your docker images for vulnerabilities. If your image fails the security scan, AppCenter displays a message indicating failure. In the event of a failure, select Logs in the app from Develop to see a list of vulnerabilities found in your image. Fix the issues, then select NEW VERSION to upload the new image. Apps with images that fail security scan are not allowed to run. Security scan is enabled by default. For information about disabling the security scan, contact Teradata Professional Services.
    Egress Port(s) Visible to admin users only, the Egress Port(s) option enables admins to add additional outbound ports for apps that need to talk to a corporate service outside the Kubernetes cluster.
    Path
    • Path applies to apps that run until stopped, and is an optional setting.
    • By default, AppCenter uses the name of the app and the AppCenter base domain as the app URL. For example, https://test.appcenter.com , where test is the name of the app and appcenter.com is the AppCenter base domain.
    • If you add a path, AppCenter appends that to the URL of the app when a job is started for this app. For example, if you add the path /mypath , AppCenter appends it to the URL as follows: https://test.appcenter.com/mypath
    • AppCenter replaces characters in the path that are not URL-friendly with a dash.
    Bypass Authentication
    • For apps that run until stopped, you can choose to bypass authentication for access to this app, meaning any user can access the app.
    • By default, the bypass option is not selected.
    • If you do not want to use AppCenter authentication but want a way to authenticate users, you will need to implement your own authentication mechanism.
    Repository Credentials (optional for public images) Credentials for the repository from which you will pull images for this app.
    NEW VERSION To change the current container, select New Version. When you save the new container information, AppCenter moves the replaced container to a Previous Versions list below the Latest Version.
    If you change the container information after adding parameters, AppCenter retains those parameters.
  5. [Optional] Select Description to select tags and enter a description.
    Option Considerations
    Add Tags
    • Tags are created by an administrator, and are optional.
    • In Add Tags, start typing the name of a tag, then select it.
    • You can select one or more tags for an app.
    • For additional tags, contact an administrator.
    Description
    • AppCenter supports plain text or GitHub Markdown.
    • For assistance with GitHub Markdown syntax, select "" in the formatting toolbar.
  6. Select Permissions to set user and app permissions.
    Option Considerations
    Managers
    • When you create an app, you are the app owner. You can add managers by user name and LDAP groups. Managers you add are considered owners.
    Privacy
    • Apps that run until stopped are public and cannot be made private.
    • Apps that run once or on schedule are private by default. You can turn privacy off. For private apps, only the app owner and other users they added as managers, can view, edit, and delete the app.
  7. Select Settings to add and remove required and optional settings for users who run this app.
    If the Docker image includes environment variables, AppCenter adds them to the settings automatically, and you can modify them and add additional settings. If the Docker image does not include any environment variables, no settings or related options appear.
    Option Considerations
    Default System Config For apps that run once or on schedule only, select the default system that this app will run against, then enter system settings.
    ADD FIELD
    • The Name field does not support spaces.
    • Hint is a brief description of the parameter that appears when a user runs the app.
    • You can enter a Default parameter of up to 5000 characters maximum.
    • If you add a parameter and select Upload as the type, AppCenter prompts you to upload the parameters file when you run a job for this app.
    • If you select Required for a setting and it is not part of the job execution parameters, the job will fail.
    • If you select Hidden for a setting, AppCenter hides that parameter when running the job.
    • If you want to use SQL for parameterization, AppCenter supports simple SQL queries. It does not support the following statements:
      • CREATE
      • DELETE
      • DROP
      • INSERT
      • JOIN
      • TRUNCATE
      • UPDATE
      The SQL parameter can list data from only one column. Therefore, you cannot use * or multiple projections on the table. For example, you cannot use:
      Select * from table-name;
      Select col1,col2,col3 from table-name;
    • Apps that run once or on schedule support visualizations, including built-in and custom visualizations. If there are no visualization options associated with the Docker image selected for this app, visualization settings are unavailable in the settings. If you select Custom (Upload), follow the instructions on the screen for installing and running Node.js and Polymer Bundler to upload the resulting bundled file with the visualization.
    • For apps that run once or on schedule, SQL type fields includes an Allow user to select multiple values from this query option. When you run the app, AppCenter allows you to select multiple values for the query based on the associated database table values.
    • For apps that run once or on a schedule, schedule options are selected when you run the app.
    • If you change the container information after additional settings have been added by a user, AppCenter retains the settings in new versions of that app unless you delete the settings.
    Parameter actions
    • To edit, reorder, or delete parameters, select "".
    • The order of the parameters here determines the order in which they are displayed when you run the app.
    Visualizations
    • Only apps that run once or on schedule support visualizations, including built-in and custom visualizations.
    • If there are no visualization options associated with the Docker image, these settings are not visible.
    • If you select Custom (Upload) as the Type, follow the instructions on the screen for installing and running Node.js and Polymer Bundler to upload the resulting bundled file with the visualization.
  8. [Optional] Select App Overview, then on App info change the app icon and color, Memory, and CPU settings.
    Option Considerations
    Icon and color
    • AppCenter automatically assigns an app icon and color. You can change one or both settings.
    Memory
    • Accept the default settings.
      Teradata recommends that you change the Memory and CPU values only if you encounter messages or errors that indicate limited resources. For example, if you run a job and it remains in the state of waiting for resources. If a job fails due to memory issues, an error log is generated and available from Execution History.
    CPU