Skip to main content
Version: 13.x (Current)

Project Manage Handbook

Mia-Platform Console allows you to create and manage multiple Projects, each one with its own set of APIs, microservices, and applications.
There are a different set of permissions based on whether you want to create or edit a Project, make sure you have the ones you need.

danger

To create a new Project you must have the permission console.company.project.create and you need to have already set up provider, company, and template. More detail about the prerequisites can be found in Project Management.

Project creation​

To create the Project, select a Company and then click the Create Project button located at the top of the sidebar.

create-project-button

The Project creation is divided in three different steps.

Step 1: General​

In this step, you are required to insert the general information about your new Project:

  • Company (required): you are required to select, from a list of pre-configured companies, your company, which enables you to keep the same configuration for different Projects;
  • Project name (required): the name of your Project, which will be shown in the Project card in the Home section of the Console;
  • Description: the description of your Project, which will be shown in the Project card in the Home section of the Console.

create-project1

Step 2: Repository​

In this step, it is indicated the location of your new Project and you have to choose its template.
By default, the Project is saved on the default Git provider, but you can choose to save it to a different one by clicking on the Change Git provider button.
The Git provider can be changed only if the company has been configured with more than one Git provider.

  • Git Provider: this field represents the provider ID used by your chosen company (e.g. gitlab, github, azure-devops, bitbucket);
  • Git repo path: this is the path, calculated from Project name and company, where the configuration will be saved on the Git provider. It specifies the location of your Project on the Git provider website;
  • Visibility: the visibility states the status of your Project once it will be saved on the Git provider. If it is internal, all the internal users of the Git provider instance can see the Project. If it is private, only who has access to the repository can see the Project;
  • Template (required): you have to select, from a list of pre-configured templates, your template, which enables you to use pre-filled configurations for your Project.
tip

If you are using the PaaS Mia-Platform Console, two main templates are available: one with all the core services, and the other which is similar, but without CMS. More information about how to use them at Create Project.

create-project2

Step 3: Environments​

In this step, an overview of the configuration of your Project environments is presented. This section is entirely read-only, since the information displayed are retrieved from the selected company and, therefore, they are already configured and not editable:

  • Environment name: the name given to your environment;
  • Environment ID: the human-readable ID set to your environment;
  • Host: the host which exposes documentation and APIs;
  • Backoffice Host: the host which exposes CMS and backoffice APIs;
  • Cluster Host: the IP of the Kubernetes cluster where the Project will be deployed;
  • Namespace: the namespace taken from Kubernetes;
  • Description: the description of your environment.

Moreover, a label Production is displayed next to the title of the dropdown card in case the corresponding environment is labeled as a production environment.

create-project3

For security reasons, and since after this step the Project will be effectively created, when trying to proceed further a confirmation modal is displayed. By clicking on Create, the Project will be irreversibly generated.

create-project-modal

At the end of the process, your Project will be visible in the Home section of your Console.