How to install a service

Before installing a service instance, make sure it is initialized, typically accomplished by executing the blueprint describing the blueprint, see the section about how to execute a blueprint.

You can install a service instance in multiple ways:

• Using the Telegram Chatbot
• In the Cockpit Portal
• Using the Cockpit API
• At the CLI

Using the Telegram Chatbot

@todo

Using the Cockpit Portal

See the Getting started with blueprints section.

Using the Cockpit API

In order to use the Cockpit API you first need to obtain an JWT, as documented in the section about how to get a JWT.

Once you got the JWT, you can install a service instance:

curl -H "Authorization: bearer JWT"  /
     -d "action=install&async=true&force=false&instance=INSTANCE-NAME&role=ROLE"
     https://BASE_URL/api/ays/repository/REPOSITORY-NAME/execute

So for instance to install the user as described in the blueprint documented in the sections How to create a blueprint and How to execute a blueprint:

curl -H "Authorization: bearer JWT"  /
     -d "action=install&async=true&force=false&instance=user1&role=ovc_user"
     https://BASE_URL/api/ays/repository/REPOSITORY-NAME/execute

In order to uninstall the user, check the section about How to uninstall a service.

Also see the section about the API Console

At the CLI

@todo