ballerina/kubernetes package
Annotations
| Name | Attachement Points | Data Type | Description |
|---|---|---|---|
| ConfigMap | service | ConfigMapMount | @kubernetes:ConfigMap annotation to configure config maps |
| Deployment | endpoint, service | DeploymentConfiguration | @kubernetes:Deployment annotation to configure deplyoment yaml |
| HPA | service | PodAutoscalerConfig | @kubernetes:HPA annotation to configure horizontal pod autoscaler yaml |
| Ingress | endpoint, service | IngressConfiguration | @kubernetes:Ingress annotation to configure ingress yaml |
| Job | function | JobConfig | @kubernetes:Job annotation to configure kubernetes jobs |
| PersistentVolumeClaim | service | PersistentVolumeClaims | @kubernetes:PersistentVolumeClaim annotation to configure Persistent Volume Claims |
| Secret | service | SecretMount | @kubernetes:Secret annotation to configure secrets |
| Service | service, endpoint | ServiceConfiguration | @kubernetes:Service annotation to configure service yaml |
Records Summary
| Record | Description | ||
|---|---|---|---|
| ConfigMap | Kubernetes Config Map volume mount |
||
| ConfigMapMount | Secret volume mount configurations for kubernetes |
||
| DeploymentConfiguration | Kubernetes deployment configuration |
||
| FileConfig | External file type for docker |
||
| IngressConfiguration | Kubernetes ingress configuration |
||
| JobConfig | value:"Kubernetes job configuration |
||
| PersistentVolumeClaimConfig | Kubernetes Persistent Volume Claim |
||
| PersistentVolumeClaims | Persistent Volume Claims configurations for kubernetes |
||
| PodAutoscalerConfig | Kubernetes Horizontal Pod Autoscaler configuration |
||
| Secret | Kubernetes secret volume mount |
||
| SecretMount | Secret volume mount configurations for kubernetes |
||
| ServiceConfiguration | Kubernetes service configuration |
public type ConfigMap
Kubernetes Config Map volume mount
| Field Name | Data Type | Default Value | Description |
|---|---|---|---|
| name | string |
|
|
| mountPath | string |
|
|
| readOnly | boolean |
|
|
| data | string[] |
|
public type ConfigMapMount
Secret volume mount configurations for kubernetes
| Field Name | Data Type | Default Value | Description |
|---|---|---|---|
| ballerinaConf | string |
|
|
| configMaps | kubernetes:ConfigMap[] |
|
public type DeploymentConfiguration
Kubernetes deployment configuration
| Field Name | Data Type | Default Value | Description |
|---|---|---|---|
| name | string |
|
|
| labels | map |
|
|
| replicas | int |
|
|
| enableLiveness | string |
|
|
| livenessPort | int |
|
|
| initialDelaySeconds | int |
|
|
| periodSeconds | int |
|
|
| imagePullPolicy | string |
|
|
| image | string |
|
|
| env | map |
|
|
| buildImage | boolean |
|
|
| dockerHost | string |
|
|
| username | string |
|
|
| password | string |
|
|
| baseImage | string |
|
|
| push | boolean |
|
|
| dockerCertPath | string |
|
|
| copyFiles | kubernetes:FileConfig[] |
|
public type FileConfig
External file type for docker
| Field Name | Data Type | Default Value | Description |
|---|---|---|---|
| source | string |
|
|
| target | string |
|
public type IngressConfiguration
Kubernetes ingress configuration
| Field Name | Data Type | Default Value | Description |
|---|---|---|---|
| name | string |
|
|
| endpointName | string |
|
|
| labels | map |
|
|
| annotations | map |
|
|
| hostname | string |
|
|
| path | string |
|
|
| targetPath | string |
|
|
| ingressClass | string |
|
|
| enableTLS | boolean |
|
public type JobConfig
value:"Kubernetes job configuration
| Field Name | Data Type | Default Value | Description |
|---|---|---|---|
| name | string |
|
|
| labels | map |
|
|
| restartPolicy | string |
|
|
| backoffLimit | string |
|
|
| activeDeadlineSeconds | string |
|
|
| schedule | string |
|
|
| env | map |
|
|
| imagePullPolicy | string | ||
| image | string |
|
|
| buildImage | boolean |
|
|
| dockerHost | string |
|
|
| username | string |
|
|
| password | string |
|
|
| baseImage | string |
|
|
| push | boolean |
|
|
| dockerCertPath | string |
|
public type PersistentVolumeClaimConfig
Kubernetes Persistent Volume Claim
| Field Name | Data Type | Default Value | Description |
|---|---|---|---|
| name | string |
|
|
| mountPath | string |
|
|
| accessMode | string |
|
|
| volumeClaimSize | string |
|
|
| readOnly | boolean |
|
public type PersistentVolumeClaims
Persistent Volume Claims configurations for kubernetes
| Field Name | Data Type | Default Value | Description |
|---|---|---|---|
| volumeClaims | kubernetes:PersistentVolumeClaimConfig[] |
|
public type PodAutoscalerConfig
Kubernetes Horizontal Pod Autoscaler configuration
| Field Name | Data Type | Default Value | Description |
|---|---|---|---|
| name | string |
|
|
| labels | map |
|
|
| minReplicas | int |
|
|
| maxReplicas | int |
|
|
| cpuPercentage | int |
|
public type Secret
Kubernetes secret volume mount
| Field Name | Data Type | Default Value | Description |
|---|---|---|---|
| name | string |
|
|
| mountPath | string |
|
|
| readOnly | boolean |
|
|
| data | string[] |
|
public type SecretMount
Secret volume mount configurations for kubernetes
| Field Name | Data Type | Default Value | Description |
|---|---|---|---|
| secrets | kubernetes:Secret[] |
|
public type ServiceConfiguration
Kubernetes service configuration
| Field Name | Data Type | Default Value | Description |
|---|---|---|---|
| name | string |
|
|
| labels | map |
|
|
| serviceType | string |
|