Using the catalog
In this section we will explore the different ways by which you can interact with the catalog:
- On default versions
- Listing existing applications
- Obtaining information about an application
- Deploying an application from the catalog
- Uploading an application to the catalog
- Downloading an application
- Removing an application
- Getting catalog summary
Prerequirements
- 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
On of the first operation 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. Click on the upper left corner .
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
...
In the webUI you will filter your own applications selecting the your namespace tab.
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 select the application you want to see in the web UI.
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 requiered, by default, the application will we deployed in the environment where the user is logged.
Another way to deploy an application from the catalog is by clicking on the “deploy” button on the application information screen. Aflter that, select the environment where the application will be deployed and confirm the deployment.
Uploading an application
Uploading 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 describe in The application catalog help.
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
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
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