Link Search Menu Expand Document

Starting with the CLI

The playground Client is the client that allows the users to manager their accounts and applications with a command line.

Install Playground-CLI

Prerequisites:

  • Command curl installed.
  • Command su or sudo if the installation is performed by a user other than root.

Execute

curl -O https://storage.googleapis.com/artifacts.playground.napptive.dev/installer.sh && bash installer.sh
...

playground installed into /usr/local/bin/ successfully.

***************************************************
* Playground installed successfully!  👌          *
*                                                 *
* By proceeding, you are accepting the NAPPTIVE   *
* terms and conditions                            *
* https://napptive.com/terms-and-conditions       *
*                                                 *
* You can visit our documentation page            *
* for more information https://docs.napptive.com/ *
* ENJOY!!!    👋                                  *
***************************************************

The playground CLI will be installed in /usr/local/bin directory, and will be automatically in the PATH and ready to use.

Manual installations are also possible following the installation documentation.

Signup process

First you need to signup for the service. We leverage GitHub as the OAuth provider so we will not store or have access to any of your credentials. Check the Terms & Conditions of the service for more information.

The first time yoy login into the plaftorm, the signup process will be launched. You will be redirect to GitHub were you will be asked to authorize the Napptive Playground to have access to your name and email.

playground login

Authorize through GitHub

Login success

Once you authorize the application, you will be loged into the system. You will have an account available to work on it

Deploy an application

With all the tools ready, let’s deploy an application. To do this we will leverage the catalog of existing applications, selecting one, and deploying it into the default environment. Follow the steps to get your first application up and running.

  1. Deploy an application

    To confirm that you have logged successfully, you may use any playground command. For example:

     playground env info
    
     ...
     Server version: v1.20.9-gke.1001 OAM: v0.2.1
     CREATION_TIME                           CREATED_BY
     2021-09-01 16:03:48.452752 +0000 UTC    username
    
     ACCOUNT    ENV        CPU     RAM       STORAGE
     account    env        0/1     0/4000    0/1000
    
     DESCRIPTION
     environment description 
    

    The catalog provides a collection of applications that are ready to be deployed. Check the catalog documentation to learn how you can create and upload your own applications. For the purpose of this example, let’s deploy Drawio which is a simple tool to create diagrams online. First, list the available applications to select the version to be deployed.

     playground catalog list
    
     ...
     APP_ID                                 NAME
     ...
     napptive/drawio:14.3.0                 Drawio
     ...
    

    Next, copy the name of the app and its version and deploy it with:

     playground catalog deploy napptive/drawio:14.3.0
    
     ...
     Current environment: account/environment
     STATUS     INFO
     SUCCESS    application [drawio] deployed
    
     CREATED
     core.oam.dev/v1alpha2, Kind=Component "drawio" created
     core.oam.dev/v1alpha2, Kind=ApplicationConfiguration "drawio" created
    
     playground apps
    
     Current environment: account/environment
     NAME      STATUS
     drawio    APP_OK
    

    The deployment of the application may take a few seconds depending on the number of components, image size, etc. until the status becomes OK

    If the application is not running after a few minutes, check more information about how to deploy OAM applications and/or our FAQ to diagnose the issue.

  2. To access the web using the CLI, use:

     playground apps open drawio
    

    To obtain more details about the applications, use the command below:

     playground apps info drawio
    
     ...
     Current environment: account/environment
     NAME      STATUS
     drawio    APP_OK
    
     COMPONENT    STATUS    SCOPES    TRAITS
     drawio       OK                  drawio-ingress, example-appconfig-trait
    
     COMPONENT    INGRESSES
     drawio       drawio-<your_username>.apps.staging.napptive.dev   
    

    The INGRESSES contain the URLS associated with the application.

Cleanup

To remove all the components and make space for other applications if needed use:

playground apps delete drawio
...
Current environment: account/environment
STATUS     INFO
SUCCESS    application [drawio] removed

Detailed information can be found on the removing apps guide

What’s next