Documentation
¶
Index ¶
- type App
- type AppIn
- type AppInHealthCheck
- type AppInLimits
- type AppInRollingUpdate
- type AutoScale
- type BadRequest
- type Deployment
- type EnvVar
- type Error
- type Forbidden
- type GenericError
- type HealthCheckProbe
- type LimitRangeQuantity
- type Login
- type LoginToken
- type NotFound
- type Pagination
- type PaginationPagination
- type PatchAppEnvVar
- type PatchAppRequest
- type Status
- type Team
- type Unauthorized
- type User
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type App ¶
type App struct {
AppIn
/* list of the external addresses of the app
*/
AddressList []string `json:"addressList,omitempty"`
/* creator
Required: true
*/
Creator *User `json:"creator"`
/* deployment list
*/
DeploymentList []*Deployment `json:"deploymentList,omitempty"`
/* env vars
*/
EnvVars []*EnvVar `json:"envVars,omitempty"`
/* status
*/
Status *Status `json:"status,omitempty"`
}
App app
swagger:model App
type AppIn ¶ added in v0.2.0
type AppIn struct {
/* auto scale
*/
AutoScale *AutoScale `json:"autoScale,omitempty"`
/* health check
*/
HealthCheck *AppInHealthCheck `json:"healthCheck,omitempty"`
/* limits
*/
Limits *AppInLimits `json:"limits,omitempty"`
/* the name of the app
Required: true
Pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
*/
Name *string `json:"name"`
/* app process type
Pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
*/
ProcessType *string `json:"processType,omitempty"`
/* rolling update
*/
RollingUpdate *AppInRollingUpdate `json:"rollingUpdate,omitempty"`
/* number of PODs running the app
Minimum: 1
*/
Scale int64 `json:"scale,omitempty"`
/* the name of the team that this app belongs.
if the user is in only one team, this is parameter is not required
Required: true
Pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
*/
Team *string `json:"team"`
}
AppIn Application data
swagger:model AppIn
type AppInHealthCheck ¶ added in v0.2.0
type AppInHealthCheck struct {
/* check if the app is responding.
containers of the app will be restarted if this check fails
*/
Liveness *HealthCheckProbe `json:"liveness,omitempty"`
/* check if the app is fully working.
containers of the app will be removed from service endpoints if the check fails
*/
Readiness *HealthCheckProbe `json:"readiness,omitempty"`
}
AppInHealthCheck app health check
swagger:model AppInHealthCheck
type AppInLimits ¶ added in v0.2.0
type AppInLimits struct {
/* default
Required: true
*/
Default []*LimitRangeQuantity `json:"default"`
/* default request
Required: true
*/
DefaultRequest []*LimitRangeQuantity `json:"defaultRequest"`
/* limit request ratio
*/
LimitRequestRatio []*LimitRangeQuantity `json:"limitRequestRatio,omitempty"`
/* max
*/
Max []*LimitRangeQuantity `json:"max,omitempty"`
/* min
*/
Min []*LimitRangeQuantity `json:"min,omitempty"`
}
AppInLimits specifies the limit ranges of the APP
swagger:model AppInLimits
type AppInRollingUpdate ¶ added in v0.2.0
type AppInRollingUpdate struct {
/* specifies the maximum number of PODs that can be created above the desired number of PODs during deployment.
this can be percentage (of the scale) or a specific number os PODs
Required: true
Min Length: 1
Pattern: ^\d+%?$
*/
MaxSurge *string `json:"maxSurge"`
MaxUnavailable *string `json:"maxUnavailable"`
}
AppInRollingUpdate params to use when starting a new deployment
swagger:model AppInRollingUpdate
type AutoScale ¶ added in v0.2.0
type AutoScale struct {
/* target average CPU utilization (represented as a percentage of requested CPU) over all the pods
Maximum: 100
Minimum: 0
*/
CPUTargetUtilization *int64 `json:"cpuTargetUtilization,omitempty"`
/* maximum number of PODs running the app
Minimum: 1
*/
Max int64 `json:"max,omitempty"`
/* minimum number of PODs running the app
Minimum: 1
*/
Min int64 `json:"min,omitempty"`
}
AutoScale horizontal auto scale params
swagger:model AutoScale
type BadRequest ¶
type BadRequest struct {
/* code
*/
Code *int64 `json:"code,omitempty"`
/* message
*/
Message *string `json:"message,omitempty"`
}
BadRequest bad request
swagger:model BadRequest
type Deployment ¶
type Deployment struct {
/* description
Required: true
*/
Description *string `json:"description"`
/* description of the error, if any
*/
Error string `json:"error,omitempty"`
/* where the deploy process was started
*/
Origin *string `json:"origin,omitempty"`
/* uuid
Required: true
*/
UUID *string `json:"uuid"`
/* when
*/
When strfmt.DateTime `json:"when,omitempty"`
}
Deployment deployment
swagger:model Deployment
type EnvVar ¶
type EnvVar struct {
/* key
Required: true
*/
Key *string `json:"key"`
/* value
Required: true
*/
Value *string `json:"value"`
}
EnvVar app environment var
swagger:model EnvVar
type Error ¶
type Error struct {
/* http status of the error
Required: true
*/
Code *int32 `json:"code"`
/* message
Required: true
*/
Message *string `json:"message"`
/* reason of the error if any.
always represented as an enum in pascal case
*/
Reason string `json:"reason,omitempty"`
}
Error error
swagger:model Error
type Forbidden ¶
type Forbidden struct {
/* code
*/
Code *int64 `json:"code,omitempty"`
/* message
*/
Message *string `json:"message,omitempty"`
}
Forbidden forbidden
swagger:model Forbidden
type GenericError ¶ added in v0.2.0
type GenericError struct {
/* code
*/
Code int64 `json:"code,omitempty"`
/* message
*/
Message string `json:"message,omitempty"`
}
GenericError generic error
swagger:model GenericError
type HealthCheckProbe ¶ added in v0.2.0
type HealthCheckProbe struct {
/* minimum consecutive failures for the health check to be considered failed after having succeeded.
Maximum: 10
Minimum: 1
*/
FailureThreshold int64 `json:"failureThreshold,omitempty"`
/* length of time before health checking is activated
Maximum: 60
Minimum: 1
*/
InitialDelaySeconds int64 `json:"initialDelaySeconds,omitempty"`
/* path of the health check
*/
Path string `json:"path,omitempty"`
/* how often to perform the health check
Maximum: 300
Minimum: 1
*/
PeriodSeconds int64 `json:"periodSeconds,omitempty"`
/* minimum consecutive successes for the health check to be considered successful after having failed
Maximum: 10
Minimum: 1
*/
SuccessThreshold int64 `json:"successThreshold,omitempty"`
/* length of time before health checking times out
Maximum: 15
Minimum: 1
*/
TimeoutSeconds int64 `json:"timeoutSeconds,omitempty"`
}
HealthCheckProbe health check probe
swagger:model HealthCheckProbe
type LimitRangeQuantity ¶ added in v0.2.0
type LimitRangeQuantity struct {
/* quantity of the resource.
example:
can be:
binarySI: Ki | Mi | Gi | Ti | Pi | Ei
(International System of units; See: http://physics.nist.gov/cuu/Units/binary.html)
decimalSI: m | "" | k | M | G | T | P | E
Note that 1024 = 1Ki but 1000 = 1k
Required: true
Pattern: ^\d+(([KMGTPE]{1}i)|([mkMGTPE]))?$
*/
Quantity *string `json:"quantity"`
/* resouce type
Required: true
*/
Resource *string `json:"resource"`
}
LimitRangeQuantity limit range quantity
swagger:model LimitRangeQuantity
type Login ¶
type Login struct {
/* email
Required: true
Min Length: 1
*/
Email *strfmt.Email `json:"email"`
/* password
Required: true
Min Length: 1
*/
Password *strfmt.Password `json:"password"`
}
Login login
swagger:model Login
type LoginToken ¶
type LoginToken struct {
/* token
*/
Token string `json:"token,omitempty"`
}
LoginToken login token
swagger:model LoginToken
type NotFound ¶
type NotFound struct {
/* code
*/
Code *int64 `json:"code,omitempty"`
/* message
*/
Message *string `json:"message,omitempty"`
}
NotFound not found
swagger:model NotFound
type Pagination ¶
type Pagination struct {
/* pagination
*/
Pagination *PaginationPagination `json:"pagination,omitempty"`
}
Pagination pagination
swagger:model Pagination
type PaginationPagination ¶
type PaginationPagination struct {
/* length
*/
Length int64 `json:"length,omitempty"`
/* next Url
*/
NextURL string `json:"nextUrl,omitempty"`
/* previous Url
*/
PreviousURL string `json:"previousUrl,omitempty"`
/* self
*/
Self string `json:"self,omitempty"`
/* size
*/
Size int64 `json:"size,omitempty"`
}
PaginationPagination pagination pagination
swagger:model PaginationPagination
type PatchAppEnvVar ¶
type PatchAppEnvVar struct {
/* key
Required: true
*/
Key *string `json:"key"`
/* value
*/
Value string `json:"value,omitempty"`
}
PatchAppEnvVar app environment var
swagger:model PatchAppEnvVar
type PatchAppRequest ¶
type PatchAppRequest struct {
/* op
Required: true
*/
Op *string `json:"op"`
/* path
Required: true
*/
Path *string `json:"path"`
/* value
Required: true
*/
Value []*PatchAppEnvVar `json:"value"`
}
PatchAppRequest used to create a patch update to an app
swagger:model PatchAppRequest
type Status ¶ added in v0.2.0
type Status struct {
/* cpu
Required: true
*/
CPU *int32 `json:"cpu"`
/* pods
Required: true
*/
Pods *int32 `json:"pods"`
}
Status status
swagger:model Status
type Team ¶
type Team struct {
/* apps
*/
Apps []*App `json:"apps,omitempty"`
/* email
*/
Email strfmt.Email `json:"email,omitempty"`
/* i am member
*/
IAmMember bool `json:"iAmMember,omitempty"`
/* id
*/
ID int64 `json:"id,omitempty"`
/* members
*/
Members []*User `json:"members,omitempty"`
/* name
Required: true
Min Length: 3
Pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
*/
Name *string `json:"name"`
/* url
*/
URL string `json:"url,omitempty"`
}
Team team
swagger:model Team
type Unauthorized ¶
type Unauthorized struct {
Code *int64 `json:"code,omitempty"`
Message *string `json:"message,omitempty"`
}
Unauthorized unauthorized
swagger:model Unauthorized
type User ¶
type User struct {
/* email
Required: true
Min Length: 8
*/
Email *string `json:"email"`
/* id
*/
ID int64 `json:"id,omitempty"`
/* is admin
Required: true
*/
IsAdmin *bool `json:"isAdmin"`
/* name
Required: true
Min Length: 5
*/
Name *string `json:"name"`
/* password
Required: true
Min Length: 8
*/
Password *string `json:"password"`
/* teams
*/
Teams []*Team `json:"teams,omitempty"`
}
User user
swagger:model User
Source Files
¶
Directories
Click to show internal directories.
Click to hide internal directories.