armada/docs/source/operations/guide-api.rst

Armada Restful API v1.0

Description

The Armada API provides the services similar to the cli via Restful endpoints

Base URL

https://armada.localhost/api/v1.0/

DEFAULT

GET /releases

Summary

Get tiller releases

Request

Responses

200

obtain all running releases

Example:

{
    "message": {
        "namespace": [
            "armada-release",
            "armada-release"
        ],
        "default": [
            "armada-release",
            "armada-release"
        ]
    }
}

403

Unable to Authorize or Permission

405

Failed to perform action

GET /status

Summary

Get armada running state

Request

Responses

200

obtain armada status

Example:

{
    "message": {
        "tiller": {
            "state": True,
            "version": "v2.5.0"
        }
    }
}

403

Unable to Authorize or Permission

405

Failed to perform action

POST /validatedesign

Summary

Validates Armada manifest

Request

Responses

200

obtain valid status true/false

Example:

{
    "valid": true
}

403

Unable to Authorize or Permission

405

Failed to perform action

POST /apply

Summary

Install/Update Armada Manifest

Request

Body

Name	Required	Type	Format	Properties	Description
disable-update-post	boolean
disable-update-pre	boolean
dry-run	boolean
enable-chart-cleanup	boolean
tiller-host	string
tiller-port	int
timeout	int
wait	boolean

Armada schema:

{
    "api": true,
    "armada": {}
}

Responses

200

Successful installation/update of manifest

Example:

{
    "message": {
        "installed": [
            "armada-release",
            "armada-release"
        ],
        "updated": [
            "armada-release",
            "armada-release"
        ],
        "diff": [
            "values": "value diff",
            "values": "value diff 2"
        ]
    }
}

403

Unable to Authorize or Permission

405

Failed to perform action

POST /test/{release}

Summary

Test release name

Parameters

Name	Located in	Required	Type	Format	Properties	Description
release	path	Yes	string			name of the release to test

Request

Responses

200

Succesfully Test release response

Example:

{
    "message": {
        "message": "armada-release",
        "result": "No test found."
    }
}

403

Unable to Authorize or Permission

405

Failed to perform action

POST /tests

Summary

Test manifest releases

Request

Body

Name	Required	Type	Format	Properties	Description
armada	Yes

Armada schema:

{
    "armada": {}
}

Responses

200

Successful Test of manifest

Example:

{
    "message": {
        "failed": [
            "armada-release",
            "armada-release"
        ],
        "passed": [
            "armada-release",
            "armada-release"
        ],
        "skipped": [
            "armada-release",
            "armada-release"
        ]
    }
}

403

Unable to Authorize or Permission

405

Failed to perform action

Data Structures

Armada Request Model Structure

Name	Required	Type	Format	Properties	Description
disable-update-post	boolean
disable-update-pre	boolean
dry-run	boolean
enable-chart-cleanup	boolean
tiller-host	string
tiller-port	int
timeout	int
wait	boolean

Armada schema:

Armada Response Model Structure

Name	Required	Type	Format	Properties	Description
message	No

Message schema:

Name	Required	Type	Format	Properties	Description
installed	No	array of string
updated	No	array of string
values	No	array of string

Releases Response Model Structure

Name	Required	Type	Format	Properties	Description
message	No

Message schema:

Name	Required	Type	Format	Properties	Description
namespace	No	array of string

Status Response Model Structure

Name	Required	Type	Format	Properties	Description
message	No

Message schema:

Name	Required	Type	Format	Properties	Description
tiller	No

Tiller schema:

Name	Required	Type	Format	Properties	Description
state	No	string
version	No	string

Test Response Model Structure

Name	Required	Type	Format	Properties	Description
message	No

Message schema:

Name	Required	Type	Format	Properties	Description
message	No	string
result	No	string

Tests Request Model Structure

Name	Required	Type	Format	Properties	Description
armada	Yes

Armada schema:

Tests Response Model Structure

Name	Required	Type	Format	Properties	Description
message	No

Message schema:

Name	Required	Type	Format	Properties	Description
failed	No	array of string
passed	No	array of string
skipped	No	array of string

Validate Response Model Structure

Name	Required	Type	Format	Properties	Description
valid	No	boolean