# Maintain Project

Before starting this section, please ensure that you have read the Main Process section to understand the main process and related terminology for running pipelines and deploying applications in Nautes.

By maintaining products and projects, you can build management units consistent with the microservice architecture of your products.

A project corresponds to a microservice, and each project has its own code repositories. You can integrate and deploy projects using Kubernetes clusters, and store versioned artifacts in artifact repositories. A product can contain multiple projects.

Support both Command Line and API for maintaining projects.

# Prerequisites

# Create Access Token

You need to create an access token to use as a request header for requesting APIs. For more information, refer to Create Access Token.

# Import Certificates

Before accessing the Nautes API Server via the HTTPS protocol, please import certificates first.

# Create Product

Projects belong to products, so you need to create at least one product.

# Create and Update Project (API)

# Compose Create and Update Project Request

Compose an API request example by API definition Project_SaveProject and add the access token as a request header.

    # Replace the variable $api-server-address with the access address of the Nautes API Server.
    # Replace the variable $gitlab-access-token with the GitLab access token.
    # Replace the variable $product-name with the name of the product to which the project belongs.
    # Replace the variable $project-name with the project name.
    curl -X 'POST' \
        'HTTP://$api-server-address/api/v1/products/$product-name/projects/$project-name' \
        -H 'accept: application/json' \
        -H 'Content-Type: application/json' \
        -H 'Authorization: Bearer $gitlab-access-token' \
        -d '{
                # The programming language of the project
                "language": $project-language
            }'

The request example after replacing the variables is shown below:

    curl -X 'POST' \
        'HTTP://xxx.xxx.xxx.xxx:xxxxx/api/v1/products/nautes-labs/projects/api-server' \
        -H 'accept: application/json' \
        -H 'Content-Type: application/json' \
        -H 'Authorization: Bearer xxxxxxxxxxxxxxxxxxxx'\
        -d '{
                "language": "Go"
            }'

# Execute Create and Update Project Request

Use the curl command or other tools to execute the API request to create a project.

After the request is successful, the resource file for the project will be generated in the default.project repository of the specified product. An example of a resource file for a project is shown below:

    apiVersion: nautes.resource.nautes.io/v1alpha1
    kind: Project
    metadata:
        name: nautes-labs
        namespace: nautes
    spec:
        language: "Go"
        product: "nautes-labs"

When requesting the API to update a project, the resource file for the project will also be updated.

If your account is a member of the GitLab group and has write permission to the main branch of the default.project repository, you can create or update projects.

# Delete Project (API)

Before deleting a project, please delete all entities and resources related to the project, such as project pipeline runtimes, deployment runtimes and code repositories, otherwise the deletion cannot be performed.

# Compose Delete Project Request

Compose an API request example by API definition Project_DeleteProject and add the access token as a request header.

    curl -X 'DELETE' \
        'HTTP://$api-server-address/api/v1/products/$product-name/projects/$project-name' \
        -H 'accept: application/json' \
        -H 'Authorization: Bearer $gitlab-access-token'

The request example after replacing the variables is shown below:

    curl -X 'DELETE' \
        'HTTP://xxx.xxx.xxx.xxx:xxxxx/api/v1/products/nautes-labs/projects/api-server' \
        -H 'accept: application/json' \
        -H 'Authorization: Bearer xxxxxxxxxxxxxxxxxxxx'

# Execute Delete Project Request

Use the curl command or other tools to execute the API request to delete a project.

After the request is successful, the resource file for the project will be deleted in the default.project repository of the specified product.

If your account is a member of the GitLab group and has write permission to the main branch of the default.project repository, you can delete projects.

# List Projects (API)

# Compose List Projects Request

Compose an API request example by API definition Project_ListProjects and add the access token as a request header.

    curl -X 'GET' \
        'HTTP://$api-server-address/api/v1/products/$product-name/projects' \
        -H 'accept: application/json' \
        -H 'Authorization: Bearer $gitlab-access-token'

The request example after replacing the variables is shown below:

    curl -X 'GET' \
        'HTTP://xxx.xxx.xxx.xxx:xxxxx/api/v1/products/nautes-labs/projects' \
        -H 'accept: application/json' \
        -H 'Authorization: Bearer xxxxxxxxxxxxxxxxxxxx'

# Execute List Projects Request

Use the curl command or other tools to execute the API request to list projects. The response example for the project list is shown below:

{
    "items": [
        {
            "product": "nautes-labs",
            "name": "api-server",
            "language": "GO"
        },
        {
            "product": "nautes-labs",
            "name": "cluster-operator",
            "language": "GO"
        }
    ]
}

If your account is a member of the GitLab group and has read permission to the default.project repository, you can list projects authorized for you.

# View Project Details (API)

# Compose View Project Details Request

Compose an API request example by API definition Project_GetProject and add the access token as a request header.

    curl -X 'GET' \
        'HTTP://$api-server-address/api/v1/products/$product-name/projects/$project-name' \
        -H 'accept: application/json' \
        -H 'Authorization: Bearer $gitlab-access-token'

The request example after replacing the variables is shown below:

    curl -X 'GET' \
        'HTTP://xxx.xxx.xxx.xxx:xxxxx/api/v1/products/nautes-labs/projects/api-server' \
        -H 'accept: application/json' \
        -H 'Authorization: Bearer xxxxxxxxxxxxxxxxxxxx'

# Execute View Project Details Request

Use the curl command or other tools to execute the API request to view the project details. The response example for viewing the project details is similar to that of listing projects.

If your account is a member of the GitLab group and has read permission to the default.project repository, you can view the details of projects authorized for you.

# Force Create/Update/Delete Project (API)

For special scenarios in which API verification needs to be skipped, refer to the Initialize a Product section.

Taking the creation of a project as an example, if there are invalid resources (such as a cluster related to an environment that has been destroyed) in the product to which the project belongs, you can forcibly submit a request by adding the insecure_skip_check query parameter with its value set to true, to submit the project resource file. The request example is shown below:

    curl -X 'POST' \
        'HTTP://xxx.xxx.xxx.xxx:xxxxx/api/v1/products/nautes-labs/projects/cluster-operator?insecure_skip_check=true ' \
        -H 'accept: application/json' \
        -H 'Content-Type: application/json' \
        -H 'Authorization: Bearer xxxxxxxxxxxxxxxxxxxx'\
        -d '{
                "language": "Go"
            }'
    ```

← Maintain Product Maintain Code Repository and its Authorization →