How to create a blueprint

You can create a blueprint in multiple ways:

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

All are discussed here below.

Make sure to validate your blueprint first to have valid YAML format using a tool like YAML Lint.

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 create a blueprint, for instance here below for creating a new user "mike" on gig.demo.greenitglobe.com:

curl -H "Authorization: bearer JWT"  /
     -H "Content-Type: application/json" /
     -d '{"name":"user1.yaml","content":"ovc_user__user1:\n  g8.client.name: 'gig'\n  username: 'mike'\n  email: '[email protected]'\n  provider: 'itsyouonline'"}'
     https://BASE_URL/ays/repository/REPO_NAME/blueprint/

Note that the above blueprint will not create the user. Two more steps are are required for that, first execute the blueprint and then install the user, respectively documented in the sections How to execute a blueprint and How to install a service.

Also see the section about the API Console

At the CLI

@todo

Also see How to add a user.