Example specification:
| Code Block |
|---|
{
"id": "uniqueid",
"key": "cloud9gomykey",
"label": "Cloud9 GOMy Service Display Name",
"image": "ndslabs/cloud9-gomyimage:latest",
"display": "stack",
"access": "external",
"description": "UnopinionatedDescription Goof development environment based on Cloud9my service",
"ports": [
{
"port": 80,
"protocol": "http"
},
{
"port": 8000,
"protocol": "http"
},
{
"port": 8080,
"protocol": "http"
}
],
"repositories": [
{
"name": "https://github.com/golang/example",
"type": "git"
}
],
"developerEnvironment" : "cloud9godevenvkey",
"volumeMounts":[
{ "mountPath": "/workspace", "name": "cloud9go" }
],
"readinessProbe" : {
"type" : "http",
"path" : "/favicon.ico",
"port" : 80,
"initialDelay": 10,
"timeout" : 600
},
"resourceLimits": {
"cpuMax": "1",
"cpuDefault": "100m",
"memMax": "2Gi",
"memDefault": "1Gi"
},
"tags": [
"Go", "Development Environment"
]
} |
| Field |
|---|
...
| Description | Notes |
|---|
...
| id | Unique ID | Used to uniquely identify this service |
| key | Short name | Used in Kubernetes service, RC and pod names. Should be unique |
| label | Display name | |
| description | Description | |
| image | Docker image | |
| dependencies | Optional and required depencies | Should key on ID going forward |
| display | Do we need this? | |
| access | Should |
...
| this be at the spec or stack level? |
...
| ports | List of ports exposed by this service | Currently, we assume a single port. Multiple ports means multiple NodePorts or ingress rules |
...
| . | ||
| repositories | List of source code repositories associated with this service | Should support Git/Bitbucket, Mercurial, SVN, CVS. A service can have multiple repositories. |
...
| developerEnvironment | Developer environment used to create this service | Reference to unique ID of developer environment specification |
| volumeMounts | List of volume mount points | Currently, we support a single volume mount |
| readinessProbe | Readiness probe used to determine when the service is ready | |
| resourceLimits | Resource limits for the service | |
| tags | List of tags used to describe/filter this service | Where do the tags come from |
Other:
- /tags: Get a list of valid tags
- /services?filter=tag1,tag2,tag3