EDA Store

The EDA Store is used to manage the apps inside EDA. An app is an extension that can be deployed inside an EDA cluster to extend the functionality of EDA.

In the EDA UI page, you can access the EDA Store page from System Administration > Store.

The EDA Store page provides the following views for apps:
  • All Packages: This view displays all the app packages known to the EDA Store. This view is the default when you open the App Store page.
  • My packages: This view shows all the installed apps in the current EDA deployment. Select this view by clicking the All Packages drop-down list and selecting My packages.
  • app page view: This view provides information about an app. Click any app from the All Packages or My packages views to open the page for a specific app.
    This view displays the following information about an application:
    • Description
    • Version
    • Author
    • Publish
    • Supported operation system
    • Category
    • The latest version
    • The installed version, if the app is installed
    • The application source

Apps

In the EDA UI, you can interact with apps from the System Administration > Store page.

Apps are defined by a manifest that contains the following information about the app:

  • Name or title
  • Vendor or author
  • Version
  • Published Date (build date of the App of that version)
  • Source code link
  • Git references and paths
  • License link
  • Short description
  • Main readme link
  • Documentation link
  • Screen shot links
  • Artifacts
  • Containers
  • Scripts
  • CRs
  • CRDs
  • UI design/configuration
  • Dependencies/Requirements

App dependencies

Dependencies are requirements that are defined in an app's manifest that must be satisfied before the app can be installed. The requirements can be for other apps or for a specified version of the EDA core.

If a dependency is not satisfied, such as when a required app is missing or if it is the wrong version, the impact is as follows:

  • During installation: the installation fails.
  • During an upgrade: the upgrade fails.
  • During the deletion of an app: the deletion fails.

To view the dependencies for an app, go to EDA Store and click the app's tile. Click the Required Applications tab. As shown in the following example, requirements that are satisfied are checked.

Figure 1. App requirements

App settings

If an app has fields that you can set during installation, when you click an app, the Available Settings tab shows the fields that you can set.
Figure 2. Available Settings tab
After app installation, the tab is renamed as Applied Settings.

Installing an application

After the EDA software is installed, EDA Store has access to the catalogs and registries.

All apps available for installation are displayed in the EDA Store. To navigate to the store, go to the System Administration > Store page.

You can monitor the progress of the installation on the UI or the API. If at any time the installation fails, the previous steps are rolled back, where possible.

  1. Locate the app that you want to install and click Install.
  2. If the app is available from more than one catalog, a form displays from which you can select the catalog. After making a selection, click Install to continue.
    Figure 3. Catalog selection

    The flow of the installation varies depending on whether the app has requirements or associated settings:
    • If the app has no outstanding requirements or associated settings, the system displays a Summary page with installation details and the procedure is complete.
    • If the app has associated settings, the screens that display are shown in step 3. Follow the prompts to complete the installation.
    • If the app has requirements, the screens that display are shown in step 4. Follow the prompts to complete the installation.
  3. If the app has settings associated with it, the system displays an Installation Overview that describes the installation process for this app.
    1. From the Installation Overview page, click Next to continue.
      Figure 4. Installation Overview form
    2. In the Installation settings page that displays, set the fields for your app.
      Figure 5. Installation settings page

      Click Next to continue.

    3. From the Summary page, click Install to complete the installation.
      Figure 6. Summary page for an app with settings

      The procedure is complete at this point.

  4. If an app has requirements associated with it, the Summary page displays that identifies any required app. Click Install to proceed with the installation.
    Figure 7. Summary page for an app with requirements
    The system installs the app and any app required identified in the Summary page.

Uninstalling an app

In the EDA UI, perform this task from the System Administration > Store page.
  1. Select the app that you want to uninstall and click it.
  2. Click Uninstall package.

    The EDA Store uninstalls the app. If you are trying to uninstall an app that is required for another installed app, the system displays an error.