Skip to main content

Webservice

TypeComponent

Parameters

Parameter
Type
Required
DefaultDescription
addRevisionLabelbooleanYes

false

If addRevisionLabel is true, the revision label will be added to the underlying pods

exposeTypestringYes

"ClusterIP"

Specify what kind of Service you want. options: "ClusterIP", "NodePort", "LoadBalancer"

imagestringYes

Which image would you like to use for your service

annotationsmapNo

Specify the annotations in the workload

argsarrayNo

Arguments to the entrypoint

cmdarrayNo

Commands to run in the container

containerPortintegerNo

Deprecated field, please use ports instead

cpustringNo

Number of CPU units requested for the service, e.g. 0.5 (0.5 CPU core), 1 (1 CPU core)

envarrayNo

Define arguments by using environment variables

hostAliasesarrayNo

Specify the hostAliases to add

imagePullPolicystringNo

Specify image pull policy for your service

imagePullSecretsarrayNo

Specify image pull secrets for your service

labelsmapNo

Specify the labels in the workload

limitobjectNo
livenessProbeobjectNo

Instructions for assessing whether the container is alive.

memorystringNo

Memory requested for the service, e.g. 1Gi, 1024Mi

portsarrayNo

Which ports do you want customer traffic sent to, defaults to 80

readinessProbeobjectNo

Instructions for assessing whether the container is in a suitable state to serve traffic.

volumeMountsobjectNo
volumesarrayNo

Deprecated field, use volumeMounts instead.

Template

The following tabs display the definition's Cue template and the rendered YAML. The rendered YAML is the output of the Cue template when the definition is applied to a cluster.

import (
"strconv"
"strings"
)

webservice: {
type: "component"
annotations: {
"generates.output.spectrocloud.com/ip": "{\"apiVersion\":\"v1\",\"kind\":\"Service\",\"paths\":\".spec.clusterIP,.status.loadBalancer.ingress[0].ip\"}"
"generates.output.spectrocloud.com/ports": "{\"apiVersion\":\"v1\",\"kind\":\"Service\",\"paths\":\".spec.ports\"}"
}
labels: {
"componentdefinition.spectrocloud.com/type": "application"
"definition.spectrocloud.com/category": "Application-Workload"
}
description: "Describes long-running, scalable, containerized services that have a stable network endpoint to receive external network traffic from customers."
attributes: {
status: {
customStatus: {
ready: {
readyReplicas: *0 | int
unavailableReplicas: *0 | int
} & {
if context.output.status.readyReplicas != _|_ {
readyReplicas: context.output.status.readyReplicas
}
if context.output.status.unavailableReplicas != _|_ {
unavailableReplicas: context.output.status.unavailableReplicas
}
}
message: "Ready:\(ready.readyReplicas)/\(context.output.spec.replicas); Unavailable:\(ready.unavailableReplicas)/\(context.output.spec.replicas)"
}
healthPolicy: {
ready: {
updatedReplicas: *0 | int
readyReplicas: *0 | int
replicas: *0 | int
unavailableReplicas: *0 | int
} & {
if context.output.status.updatedReplicas != _|_ {
updatedReplicas: context.output.status.updatedReplicas
}
if context.output.status.readyReplicas != _|_ {
readyReplicas: context.output.status.readyReplicas
}
if context.output.status.unavailableReplicas != _|_ {
unavailableReplicas: context.output.status.unavailableReplicas
}
if context.output.status.replicas != _|_ {
replicas: context.output.status.replicas
}
}
_isHealth: (context.output.spec.replicas == ready.readyReplicas) && (context.output.spec.replicas == ready.updatedReplicas) && (context.output.spec.replicas == ready.replicas) && (ready.unavailableReplicas == 0)
isHealth: *_isHealth | bool
if context.output.metadata.annotations != _|_ {
if context.output.metadata.annotations["wl.spectrocloud.com/disable-health-check"] != _|_ {
isHealth: true
}
}
}
}
}
}
template: {
mountsArray: [
if parameter.volumeMounts != _|_ && parameter.volumeMounts.pvc != _|_ for v in parameter.volumeMounts.pvc {
{
mountPath: v.mountPath
if v.subPath != _|_ {
subPath: v.subPath
}
name: v.name
}
},

if parameter.volumeMounts != _|_ && parameter.volumeMounts.configMap != _|_ for v in parameter.volumeMounts.configMap {
{
mountPath: v.mountPath
if v.subPath != _|_ {
subPath: v.subPath
}
name: v.name
}
},

if parameter.volumeMounts != _|_ && parameter.volumeMounts.secret != _|_ for v in parameter.volumeMounts.secret {
{
mountPath: v.mountPath
if v.subPath != _|_ {
subPath: v.subPath
}
name: v.name
}
},

if parameter.volumeMounts != _|_ && parameter.volumeMounts.emptyDir != _|_ for v in parameter.volumeMounts.emptyDir {
{
mountPath: v.mountPath
if v.subPath != _|_ {
subPath: v.subPath
}
name: v.name
}
},

if parameter.volumeMounts != _|_ && parameter.volumeMounts.hostPath != _|_ for v in parameter.volumeMounts.hostPath {
{
mountPath: v.mountPath
if v.subPath != _|_ {
subPath: v.subPath
}
name: v.name
}
},
]

volumesList: [
if parameter.volumeMounts != _|_ && parameter.volumeMounts.pvc != _|_ for v in parameter.volumeMounts.pvc {
{
name: v.name
persistentVolumeClaim: claimName: v.claimName
}
},

if parameter.volumeMounts != _|_ && parameter.volumeMounts.configMap != _|_ for v in parameter.volumeMounts.configMap {
{
name: v.name
configMap: {
defaultMode: v.defaultMode
name: v.cmName
if v.items != _|_ {
items: v.items
}
}
}
},

if parameter.volumeMounts != _|_ && parameter.volumeMounts.secret != _|_ for v in parameter.volumeMounts.secret {
{
name: v.name
secret: {
defaultMode: v.defaultMode
secretName: v.secretName
if v.items != _|_ {
items: v.items
}
}
}
},

if parameter.volumeMounts != _|_ && parameter.volumeMounts.emptyDir != _|_ for v in parameter.volumeMounts.emptyDir {
{
name: v.name
emptyDir: medium: v.medium
}
},

if parameter.volumeMounts != _|_ && parameter.volumeMounts.hostPath != _|_ for v in parameter.volumeMounts.hostPath {
{
name: v.name
hostPath: {
path: v.path
}
}
},
]

deDupVolumesArray: [
for val in [
for i, vi in volumesList {
for j, vj in volumesList if j < i && vi.name == vj.name {
_ignore: true
}
vi
},
] if val._ignore == _|_ {
val
},
]

output: {
apiVersion: "apps/v1"
kind: "Deployment"
spec: {
selector: matchLabels: {
"wl.spectrocloud.com/component": context.name
}

template: {
metadata: {
labels: {
if parameter.labels != _|_ {
parameter.labels
}
if parameter.addRevisionLabel {
"wl.spectrocloud.com/revision": context.revision
}
"wl.spectrocloud.com/name": context.workloadName
"wl.spectrocloud.com/component": context.name
}
if parameter.annotations != _|_ {
annotations: parameter.annotations
}
}

spec: {
containers: [{
name: context.name
image: parameter.image
if parameter["containerPort"] != _|_ && parameter["ports"] == _|_ {
ports: [{
containerPort: parameter.containerPort
}]
}
if parameter["ports"] != _|_ {
ports: [for v in parameter.ports {
{
containerPort: v.containerPort
protocol: v.protocol
if v.name != _|_ {
name: v.name
}
if v.name == _|_ {
_name: "port-" + strconv.FormatInt(v.containerPort, 10)
name: *_name | string
if v.protocol != "TCP" {
name: _name + "-" + strings.ToLower(v.protocol)
}
}
}}]
}

if parameter["imagePullPolicy"] != _|_ {
imagePullPolicy: parameter.imagePullPolicy
}

if parameter["cmd"] != _|_ {
command: parameter.cmd
}

if parameter["args"] != _|_ {
args: parameter.args
}

if parameter["env"] != _|_ {
env: parameter.env
}

if context["config"] != _|_ {
env: context.config
}

if parameter["cpu"] != _|_ {
if (parameter.limit.cpu != _|_) {
resources: {
requests: cpu: parameter.cpu
limits: cpu: parameter.limit.cpu
}
}
if (parameter.limit.cpu == _|_) {
resources: {
limits: cpu: parameter.cpu
requests: cpu: parameter.cpu
}
}
}

if parameter["memory"] != _|_ {
if (parameter.limit.memory != _|_) {
resources: {
limits: memory: parameter.limit.memory
requests: memory: parameter.memory
}
}
if (parameter.limit.memory == _|_) {
resources: {
limits: memory: parameter.memory
requests: memory: parameter.memory
}
}
}

if parameter["volumes"] != _|_ && parameter["volumeMounts"] == _|_ {
volumeMounts: [for v in parameter.volumes {
{
mountPath: v.mountPath
name: v.name
}}]
}

if parameter["volumeMounts"] != _|_ {
volumeMounts: mountsArray
}

if parameter["livenessProbe"] != _|_ {
livenessProbe: parameter.livenessProbe
}

if parameter["readinessProbe"] != _|_ {
readinessProbe: parameter.readinessProbe
}

}]

if parameter["hostAliases"] != _|_ {
// +patchKey=ip
hostAliases: parameter.hostAliases
}

if parameter["imagePullSecrets"] != _|_ {
imagePullSecrets: [for v in parameter.imagePullSecrets {
name: v
},
]
}

if parameter["volumes"] != _|_ && parameter["volumeMounts"] == _|_ {
volumes: [for v in parameter.volumes {
{
name: v.name
if v.type == "pvc" {
persistentVolumeClaim: claimName: v.claimName
}
if v.type == "configMap" {
configMap: {
defaultMode: v.defaultMode
name: v.cmName
if v.items != _|_ {
items: v.items
}
}
}
if v.type == "secret" {
secret: {
defaultMode: v.defaultMode
secretName: v.secretName
if v.items != _|_ {
items: v.items
}
}
}
if v.type == "emptyDir" {
emptyDir: medium: v.medium
}
}
}]
}

if parameter["volumeMounts"] != _|_ {
volumes: deDupVolumesArray
}
}
}
}
}

exposePorts: [
if parameter.ports != _|_ for v in parameter.ports if v.expose == true {
port: v.containerPort
targetPort: v.containerPort
if v.name != _|_ {
name: v.name
}
if v.name == _|_ {
_name: "port-" + strconv.FormatInt(v.containerPort, 10)
name: *_name | string
if v.protocol != "TCP" {
name: _name + "-" + strings.ToLower(v.protocol)
}
}
if v.nodePort != _|_ && parameter.exposeType == "NodePort" {
nodePort: v.nodePort
}
if v.protocol != _|_ {
protocol: v.protocol
}
},
]

outputs: {
if len(exposePorts) != 0 {
webserviceExpose: {
apiVersion: "v1"
kind: "Service"
metadata: {
name: context.name
annotations: {
"output.spectrocloud.com/ports": ".spec.ports"
if parameter.exposeType == "ClusterIP" {
"output.spectrocloud.com/ip": ".spec.clusterIP"
}
if parameter.exposeType == "LoadBalancer" {
"output.spectrocloud.com/ip": ".status.loadBalancer.ingress[0].ip"
}
}
}
spec: {
selector: "wl.spectrocloud.com/component": context.name
ports: exposePorts
type: parameter.exposeType
}
}
}
}

parameter: {
// +usage=Specify the labels in the workload
labels?: [string]: string

// +usage=Specify the annotations in the workload
annotations?: [string]: string

// +usage=Which image would you like to use for your service
// +short=i
image: string

// +usage=Specify image pull policy for your service
imagePullPolicy?: "Always" | "Never" | "IfNotPresent"

// +usage=Specify image pull secrets for your service
imagePullSecrets?: [...string]

// +ignore
// +usage=Deprecated field, please use ports instead
// +short=p
containerPort?: int

// +usage=Which ports do you want customer traffic sent to, defaults to 80
ports?: [...{
// +usage=Number of port to expose on the pod's IP address
containerPort: int
// +usage=Name of the port
name?: string
// +usage=Protocol for port. Must be UDP, TCP, or SCTP
protocol: *"TCP" | "UDP" | "SCTP"
// +usage=Specify if the port should be exposed
expose: *false | bool
// +usage=exposed node port. Only Valid when exposeType is NodePort
nodePort?: int
}]

// +ignore
// +usage=Specify what kind of Service you want. options: "ClusterIP", "NodePort", "LoadBalancer"
exposeType: *"ClusterIP" | "NodePort" | "LoadBalancer"

// +ignore
// +usage=If addRevisionLabel is true, the revision label will be added to the underlying pods
addRevisionLabel: *false | bool

// +usage=Commands to run in the container
cmd?: [...string]

// +usage=Arguments to the entrypoint
args?: [...string]

// +usage=Define arguments by using environment variables
env?: [...{
// +usage=Environment variable name
name: string
// +usage=The value of the environment variable
value?: string
// +usage=Specifies a source the value of this var should come from
valueFrom?: {
// +usage=Selects a key of a secret in the pod's namespace
secretKeyRef?: {
// +usage=The name of the secret in the pod's namespace to select from
name: string
// +usage=The key of the secret to select from. Must be a valid secret key
key: string
}
// +usage=Selects a key of a config map in the pod's namespace
configMapKeyRef?: {
// +usage=The name of the config map in the pod's namespace to select from
name: string
// +usage=The key of the config map to select from. Must be a valid secret key
key: string
}
// +usage=Selects a field of the pod: supports metadata.name, metadata.namespace,
// `metadata.labels['<KEY>']`, `metadata.annotations['<KEY>']`, spec.nodeName,
// spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
fieldRef?: {
// +usage=Version of the schema the FieldPath is written in terms of, defaults to "v1"
apiVersion: *"v1" | string
// +usage=Path of the field to select in the specified API version
fieldPath: string
}
}
}]

// +usage=Number of CPU units requested for the service, e.g. `0.5` (0.5 CPU core), `1` (1 CPU core)
cpu?: string

// +usage=Memory requested for the service, e.g. `1Gi`, `1024Mi`
memory?: string

limit?: {
// +usage=CPU limit for the service. If not specified, the CPU limit will match the CPU requested.
cpu?: string
// +usage=Memory limit for the service. If not specified, the memory limit will match the memory requested.
memory?: string
}

volumeMounts?: {
// +usage=Mount PVC type volume
pvc?: [...{
name: string
mountPath: string
subPath?: string
// +usage=The name of the PVC
claimName: string
}]
// +usage=Mount ConfigMap type volume
configMap?: [...{
name: string
mountPath: string
subPath?: string
defaultMode: *420 | int
cmName: string
items?: [...{
key: string
path: string
mode: *511 | int
}]
}]
// +usage=Mount Secret type volume
secret?: [...{
name: string
mountPath: string
subPath?: string
defaultMode: *420 | int
secretName: string
items?: [...{
key: string
path: string
mode: *511 | int
}]
}]
// +usage=Mount EmptyDir type volume
emptyDir?: [...{
name: string
mountPath: string
subPath?: string
medium: *"" | "Memory"
}]
// +usage=Mount HostPath type volume
hostPath?: [...{
name: string
mountPath: string
subPath?: string
path: string
}]
}

// +usage=Deprecated field, use volumeMounts instead.
volumes?: [...{
name: string
mountPath: string
// +usage=Specify volume type, options: "pvc","configMap","secret","emptyDir", default to emptyDir
type: *"emptyDir" | "pvc" | "configMap" | "secret"
if type == "pvc" {
claimName: string
}
if type == "configMap" {
defaultMode: *420 | int
cmName: string
items?: [...{
key: string
path: string
mode: *511 | int
}]
}
if type == "secret" {
defaultMode: *420 | int
secretName: string
items?: [...{
key: string
path: string
mode: *511 | int
}]
}
if type == "emptyDir" {
medium: *"" | "Memory"
}
}]

// +usage=Instructions for assessing whether the container is alive.
livenessProbe?: #ExecHealthProbe | #HTTPHealthProbe | #TCPHealthProbe

// +usage=Instructions for assessing whether the container is in a suitable state to serve traffic.
readinessProbe?: #ExecHealthProbe | #HTTPHealthProbe | #TCPHealthProbe

// +usage=Specify the hostAliases to add
hostAliases?: [...{
ip: string
hostnames!: [...string]
}]
}

#ExecHealthProbe: {
// +usage=Instructions for assessing container health by executing a command. Either this attribute or the httpGet attribute or the tcpSocket attribute MUST be specified. This attribute is mutually exclusive with both the httpGet attribute and the tcpSocket attribute.
exec: {
// +usage=A command to be executed inside the container to assess its health. Each space delimited token of the command is a separate array element. Commands exiting 0 are considered to be successful probes, whilst all other exit codes are considered failures.
command!: [...string]
}

// +usage=Number of seconds after the container is started before the first probe is initiated.
initialDelaySeconds: *0 | int

// +usage=How often, in seconds, to execute the probe.
periodSeconds: *10 | int

// +usage=Number of seconds after which the probe times out.
timeoutSeconds: *1 | int

// +usage=Minimum consecutive successes for the probe to be considered successful after having failed.
successThreshold: *1 | int

// +usage=Number of consecutive failures required to determine the container is not alive (liveness probe) or not ready (readiness probe).
failureThreshold: *3 | int
}

#HTTPHealthProbe: {
// +usage=Instructions for assessing container health by executing an HTTP GET request. Either this attribute or the exec attribute or the tcpSocket attribute MUST be specified. This attribute is mutually exclusive with both the exec attribute and the tcpSocket attribute.
httpGet: {
// +usage=The endpoint, relative to the port, to which the HTTP GET request should be directed.
path: string
// +usage=The TCP socket within the container to which the HTTP GET request should be directed.
port: int
host?: string
scheme?: *"HTTP" | string
httpHeaders?: [...{
name: string
value: string
}]
}

// +usage=Number of seconds after the container is started before the first probe is initiated.
initialDelaySeconds: *0 | int

// +usage=How often, in seconds, to execute the probe.
periodSeconds: *10 | int

// +usage=Number of seconds after which the probe times out.
timeoutSeconds: *1 | int

// +usage=Minimum consecutive successes for the probe to be considered successful after having failed.
successThreshold: *1 | int

// +usage=Number of consecutive failures required to determine the container is not alive (liveness probe) or not ready (readiness probe).
failureThreshold: *3 | int
}

#TCPHealthProbe: {
// +usage=Instructions for assessing container health by probing a TCP socket. Either this attribute or the exec attribute or the httpGet attribute MUST be specified. This attribute is mutually exclusive with both the exec attribute and the httpGet attribute.
tcpSocket: {
// +usage=The TCP socket within the container that should be probed to assess container health.
port: int
}

// +usage=Number of seconds after the container is started before the first probe is initiated.
initialDelaySeconds: *0 | int

// +usage=How often, in seconds, to execute the probe.
periodSeconds: *10 | int

// +usage=Number of seconds after which the probe times out.
timeoutSeconds: *1 | int

// +usage=Minimum consecutive successes for the probe to be considered successful after having failed.
successThreshold: *1 | int

// +usage=Number of consecutive failures required to determine the container is not alive (liveness probe) or not ready (readiness probe).
failureThreshold: *3 | int
}
}