Skip to main content

Repositories

To get more information about environments, please refer to the general concepts section.

Operations​

Operations​

Create an empty environment​

TODO http call

Create an environment based on an existing environment​

TODO http call

Rename an environment​

TODO http call

Delete an environment​

TODO http call

Migrate resources from one environment to another​

TODO http call

Create a variable​

TODO http call

Update a variable​

TODO http call

Delete a variable​

TODO http call

Create a workspace​

To create a workspace, you need to have an account on OwlGrid. If you don't have one, please refer to the quickstart tutorial.

Start by logging in to the OwlGrid portal. Then, on the workspaces section of the manager, click on the Create a workspace button.

To create a workspace, you need to provide the following information:

Name: the name of the workspace. It must be unique in the organization;

Description: a short description of the workspace;

OwlGrid will generate automatically an identifier and redirect you to the workspace page.

After the workspace creation, you will need to connect a repository. The repository is used to store the code and the configuration of the workspace. OwlGrid supports only Github repositories for now.

On the first connection, you will need to authorize OwlGrid to access your Github account. Then, you will be able to select the repository you want to use. For more informations, please refer to the repository section.

Connect to repository​

Every workspace needs to be connected to a repository that stores the code and the configuration of the workspace and its resources.

info

OwlGrid supports only Github repositories for now.

To connect a workspace to a repository, this workspace need to have at least one branch name main. This branch will be used to create the main environment of your workspace. For more information about environments, please refer to the environments section.

Get workspace information​

TODO http call

Update a workspace​

TODO http call

Delete a workspace​

TODO http call

The controller is a special resource that manages a workspace. It is responsible for the following:

  • Manage the workspace identity (id, network, etc.);
  • List available resources of the workspace;
  • Attach or detach resources;
  • Manage the workspace configuration:
    • Metadata: more information here;

TODO Data model:

  • workspace
    • id
    • address
    • organization
    • cloud
    • administrator
      • id
      • password
    • creationDate
    • updateDate
  • Metadatas
    • id
    • name
    • type
    • values accepted
    • default value
    • description
    • creationDate
    • updateDate
  • Resources
    • id
    • network address
    • status