Skip to main content Link Search Menu Expand Document (external link)

Using the catalog

In this section we will explore the different ways by which you can interact with the catalog:

Help button

Deploying Wordpress app from the catalog

Pre-requirements

  • Playground is installed
playground login
Login success

On default versions

By default, if no version is specified on any of the catalog commands, the latest version is assumed.

Listing existing applications

One of the first operations you may be interested in is to check which applications are available on the catalog. To explore the contents of the catalog use:

playground catalog list
APPLICATION                            NAME
napptive/aurora-files:latest           Aurora Files. Storage platform
napptive/drawio:14.3.0                 Drawio
napptive/jupyter:ubuntu-20.04          Jupyter
napptive/mysql:5.7                     Mysql
napptive/mysql-phpmyadmin:5.7          Mysql-PHPMyAdmin
napptive/nginx:1.20.0                  NGINX server
napptive/rstudio:4.0.4                 Rstudio
napptive/tensorflow:nightly-jupyter    Tensorflow
napptive/wordpress-mysql:5.7.0         Wordpress
...

You can also list the applications stored in the catalog using the Playground Web. Click on the upper left hand corner Catalog iconto open the catalog window. Catalog summary
Catalog screen


This window features different list sortings and a search filter. The green line on the bottom of some of the apps in the list means that the application is tested by Napptive and is ready to deploy. The sorting icon Catalog sort default icon (default sorting), sets the Napptive tested and ready-to-deploy apps on the top of the list, followed by the user’s public uploaded apps. You can click the Catalog alphabetical order icon icon to sort the apps by alphabetical order, and clicking again on the same icon will reverse the order.
The search bar filters the apps list, using the typed term to match the apps names.

Alternatively, you can limit the listing to a specified namespace with:

playground catalog <another_namespace>
APPLICATION                         NAME
<another_namespace>/mysql:latest    Mysql
<another_namespace>/mysql:v0.0.1    Mysql
...

To perform the same action on the web interface, you can click on your username namespace tab. This will show the list of apps uploaded to your catalog namespace.

Catalog username namespace

Catalog username namespace


Obtaining information about an application

Each application that is published provides metadata information about the application itself, plus an optional README.md that can clarify how to work with the application once deployed (e.g., which are the default passwords). To obtain information about a given application use:

playground catalog info napptive/drawio:14.3.0
APP_ID                    NAME
napptive/drawio:14.3.0    Drawio

DESCRIPTION
Free online diagrams software

README
# Draw.io

> diagrams.net (formerly draw.io) is free online diagram software. You can use it as a flowchart
 maker, network diagram software, to create UML online, as an ER diagram tool, to design database
 schema, to build BPMN online, as a circuit diagram maker, and more. diagrams.net can import
  .vsdx, Gliffy™ and Lucidchart™ files.
...

or click in any item of the application list to display the information. The active item is marked with a top bar blue to purple gradient.

Catalog application

Catalog application


Deploying an application from the catalog

Deploying an application from the catalog is a convenient method to start using the playground without writing any code. Once you have identified the target application to be deployed, use:

playground catalog deploy napptive/drawio:14.3.0 --env=<accountName>/<environmentName>
STATUS     INFO
SUCCESS    application [drawio] deployed

CREATED
core.oam.dev/v1alpha2, Kind=Component "drawio" created
core.oam.dev/v1alpha2, Kind=ApplicationConfiguration "drawio" created

where --env flag refers to the environment where the application will be deployed. This flag is not required. By default, the application will we deployed in the environment where the user is logged in. Additionally, you can use the --name parameter to set the name of the application instance.

Another way to deploy an application from the catalog is by clicking on the “deploy” button on the application information screen. Deployment success notification

That leads to the “Deploy” screen, that enables customizing the different elements (name, environment and components configuration). To know the steps in the process to deploy from catalog using the Playground Web check the deploy first app from catalog section

Deployment success notification

Deployment success notification


Uploading an application

Uploading an application is quite simple, just execute:

playground catalog push myuser/appName:v1.0 /path/to/app
STATUS     INFO
SUCCESS    myuser/appName:v1.0 added to catalog

NOTE Your application must contain a metadata.yaml as described in The application catalog help.

Unfortunately, the web interface does not yet provide the capability of uploading applications to the catalog.

Downloading an application

To obtain a copy of the application, use:

playground catalog pull napptive/drawio:14.3.0
STATUS     INFO
SUCCESS    application saved on drawio.tgz

or click the download button Download button next to the deploy button, when any application of the list is active.

Catalog app detail

Catalog application detail


Removing an application

To remove an application use:

playground catalog remove myuser/appName:v1.0
STATUS     INFO
SUCCESS    myuser/appName:v1.0 removed from catalog

To delete an application using the interface, you just need to click on the bottom right delete button Download button

Getting catalog summary

If you want to know how many namespaces, applications and versions are in the catalog, execute:

playground catalog summary
NAMESPACES    APPLICATIONS    TAGS
2             10              11

In the Playground Web, this information is provided in the top center part in the main catalog view when no element of the applications list is active.

Catalog summary

Catalog summary