Automium CRDs (0.1.5)

Download OpenAPI specification:Download

License: Apache

Introduction

Cloud Applications need a scalable and resilient infrastructure, not just a Kubernetes cluster that operates containers. Automium is responsible for controlling the IaaS below it as well as exposing its own APIs to manage core and extras components described below.

Services

Automium provides composable and reusable services ready to be deployed in your infrastructure, such as a Kubernetes cluster. Each service is built upon a proven process of Continuous Deployments in order to test and delivery 3 components:

Ansible Role, versioned and described on GitHub with the service configurations. The role is publicly available also on Ansible Galaxy to simplify further usages.
Cloud Image baked by the CI process. Every change to the configuration is tested and delivered as a Cloud Image to the Automium catalog.
Terraform Module. Every service needs one or more infrastructure resources, such as a number of variable nodes when you deploy a cluster service. All the needed resources are described in a specific Terraform module.

Service is a core component of Automium API. It's the CRD with which the user interacts. An example of CR for creating a Kubernetes cluster could be the following:

apiVersion: core.automium.io/v1beta1
kind: Service
metadata:
  labels:
    app: kubernetes-cluster
  name: mycluster
spec:
  flavor: e3standard.x4
  replicas: 1
  version: v1.16.4-1-7d8af23e

Linked services, such as the described cluster for other node pools, must use the specific environment variable "cluster_name", like in the following example of CR:

apiVersion: core.automium.io/v1beta1
kind: Service
metadata:
  labels:
    app: kubernetes-nodepool
  name: mynodepool
spec:
  env:
  - name: cluster_name
    value: mycluster
  flavor: e3standard.x5
  replicas: 3
  version: v1.16.4-1-7d8af23e

Responses

200

An array of Services

get/apis/core.automium.io/v1beta1/namespaces/{namespace}/services

https://doc.automium.io/apis/core.automium.io/v1beta1/namespaces/{namespace}/services

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"apiVersion": "string",
"kind": "string",
"metadata": { },
"spec": 
{"env": 
[{ }
],
"extra": 
[
{"name": "string",
"parameters": { },
"version": "string"
}
],
"flavor": "string",
"replicas": 0,
"tags": 
["string"
],
"version": "string"
},
"status": 
{"moduleRef": "string",
"phase": "string"
}
}
]

Modules

WARNING: this a resource generated and managed automatically by the controller; it's not meant to be created, edited or deleted by hand. You could potentially destroy your infrastructure by playing around with this resource.

Responses

200

An array of Modules

get/apis/core.automium.io/v1beta1/namespaces/{namespace}/modules

https://doc.automium.io/apis/core.automium.io/v1beta1/namespaces/{namespace}/modules

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"apiVersion": "string",
"kind": "string",
"metadata": { },
"spec": 
{"env": 
[{ }
],
"flavor": "string",
"image": "string",
"replicas": 0,
"source": "string"
},
"status": 
{"currentReplicas": 0,
"phase": "string",
"replicas": 0,
"updatedReplicas": 0
}
}
]

Nodes

WARNING: this a resource generated and managed automatically by the controller; it's not meant to be created, edited or deleted by hand. You could potentially destroy your infrastructure by playing around with this resource.

Responses

200

An array of Nodes

get/apis/core.automium.io/v1beta1/namespaces/{namespace}/nodes

https://doc.automium.io/apis/core.automium.io/v1beta1/namespaces/{namespace}/nodes

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"apiVersion": "string",
"kind": "string",
"metadata": { },
"spec": 
{"deletionDate": "string",
"hostname": "string"
},
"status": 
{"nodeHealthChecks": 
[
{"checkID": "string",
"name": "string",
"output": "string",
"serviceID": "string",
"serviceName": "string",
"status": "string"
}
],
"nodeProperties": 
{"address": "string",
"flavor": "string",
"id": "string",
"image": "string",
"node": "string",
"publicAddress": "string"
}
}
}
]

Monitorings

WARNING: this a resource generated and managed automatically by the controller; it's not meant to be created, edited or deleted by hand.

Responses

200

An array of Monitoring

get/apis/extras.automium.io/v1beta1/namespaces/{namespace}/monitorings

https://doc.automium.io/apis/extras.automium.io/v1beta1/namespaces/{namespace}/monitorings

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"apiVersion": "string",
"kind": "string",
"metadata": { },
"spec": 
{"cluster": "string",
"parameters": { },
"version": "string"
},
"status": { }
}

Backups

WARNING: this a resource generated and managed automatically by the controller; it's not meant to be created, edited or deleted by hand.

Responses

200

An array of Backups

get/apis/extras.automium.io/v1beta1/namespaces/{namespace}/backups

https://doc.automium.io/apis/extras.automium.io/v1beta1/namespaces/{namespace}/backups

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"apiVersion": "string",
"kind": "string",
"metadata": { },
"spec": 
{"cluster": "string",
"parameters": { },
"version": "string"
},
"status": { }
}
]

Applications

Responses

200

An array of Applications

get/apis/extras.automium.io/v1beta1/namespaces/{namespace}/applications

https://doc.automium.io/apis/extras.automium.io/v1beta1/namespaces/{namespace}/applications

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"apiVersion": "string",
"kind": "string",
"metadata": { },
"spec": 
{"cluster": "string",
"name": "string",
"namespace": "string",
"parameters": { },
"project": "string",
"version": "string"
},
"status": 
{"error": "string",
"phase": "string"
}
}